External module "index"

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

Alias

Alias: object

Represents an alias for disposable object property.

Type declaration

AliasCallFunction

AliasCallFunction: function

Represents an ad-hock resource free function.

Type declaration

- (resource: any): void
- Parameters
  - resource: any
  Returns void

AliasCheckFunction

AliasCheckFunction: function

Represents an ad-hock resource check function. If resource is not disposed yet, must return "false". Otherwise, true.

Type declaration

- (resource: any): boolean
- Parameters
  - resource: any
  Returns boolean

FreeDecoratorCheckFunction

FreeDecoratorCheckFunction: function

Type declaration

- (resource: any): boolean
- Parameters
  - resource: any
  Returns boolean

Property

Property: string | symbol | Alias

Represents an object property.

Functions

asDisposable

asDisposable<T>(value: T): T & DisposableObject

- Defined in index.ts:341
TS helper for disposable classes created via disposable decorator.

Type parameters
- T
Parameters
- value: T
Returns T & DisposableObject

Const disposable

disposable<T>(target: T): any

- Defined in index.ts:212
Class decorator. Makes a given class disposable.

Type parameters
- T: Function
Parameters
- target: T
Returns any

Const free

free(config?: FreeDecoratorConfig): (Anonymous function)

- Defined in index.ts:272
Property decorator. Marks a property as a resource that needs to be dispose.

Parameters
- Optional config: FreeDecoratorConfig
Returns (Anonymous function)

Const protect

protect(config?: ProtectDecoratorConfig): (Anonymous function)

- Defined in index.ts:308
Method decorator. Does not let to invoke a given method when an instance is disposed.

Parameters
- Optional config: ProtectDecoratorConfig
Returns (Anonymous function)

Generated using TypeDoc