warning

This module provides a bunch of functions and decorators to mark functions with different warnings.

import { warn, warned } from 'core/functools/warning';

const foo = warn({context: 'unimplemented', name: 'foo', alternative: 'bar'}, () => {

});

function bar() {

}

class Baz {
  @warned({context: 'deprecated', alternative: 'newMethod'})
  oldMethod() {

  }

  newMethod() {}
}

Index

References

Functions

References

WarnedFn

Re-exports WarnedFn

Functions

warn

warn<T>(opts: WarnOptions, fn: T): T extends (...args: infer A) => infer R ? WarnedFn<A, R> : T
warn(opts: InlineWarnOptions): void
warn<T>(fn: T): T extends (...args: infer A) => infer R ? WarnedFn<A, R> : T

- Defined in src/core/functools/warning/index.ts:25
Marks a function with the specified warning

Type parameters
- T: Function
Parameters
- opts: WarnOptions
  
  additional options
- fn: T
  
  function to wrap
Returns T extends (...args: infer A) => infer R ? WarnedFn<A, R> : T
- Defined in src/core/functools/warning/index.ts:34
Emits a warning with the specified parameters

Parameters
- opts: InlineWarnOptions
  
  additional options
Returns void
- Defined in src/core/functools/warning/index.ts:40
Marks a function as non-recommended to use

Type parameters
- T: Function
Parameters
- fn: T
  
  function to wrap
Returns T extends (...args: infer A) => infer R ? WarnedFn<A, R> : T

warned

warned(target: object, key: string | symbol, descriptor: PropertyDescriptor): void
warned(opts?: WarnOptions): Function

- Defined in src/core/functools/warning/index.ts:169
Decorator for warn
decorator
see
warn

example
```
class Foo {
  @warned()
  bar() {

  }
}
```
Parameters
- target: object
- key: string | symbol
- descriptor: PropertyDescriptor
Returns void
- Defined in src/core/functools/warning/index.ts:188
Decorator for warn. This overload adds a feature to provide additional options.
see
warn

example
```
class Foo {
  @warned({alternative: 'baz'}})
  bar() {

  }
}
```
Parameters
- Optional opts: WarnOptions
Returns Function

core/functools/warning

Index

References

Functions

References

InlineWarnOptions

WarnAlternative

WarnAlternativeOptions

WarnContext

WarnExprType

WarnOptions

WarnedFn

Functions

warn

Type parameters

T: Function

Parameters

opts: WarnOptions

fn: T

Returns T extends (...args: infer A) => infer R ? WarnedFn<A, R> : T

Parameters

opts: InlineWarnOptions

Returns void

Type parameters

T: Function

Parameters

fn: T

Returns T extends (...args: infer A) => infer R ? WarnedFn<A, R> : T

warned

Parameters

target: object

key: string | symbol

descriptor: PropertyDescriptor

Returns void

Parameters

Optional opts: WarnOptions

Returns Function