Class ManagedFreeableScope

A scope to ease the management of objects that require manual resource management.

Hierarchy

ManagedFreeableScope

Index

Constructors

Properties

#disposed #scopeStack

Methods

Constructors

constructor

new ManagedFreeableScope(): ManagedFreeableScope
Returns ManagedFreeableScope

Properties

`Private` #disposed

#disposed: boolean = false

`Private` #scopeStack

#scopeStack: Freeable[] = []

Methods

dispose

dispose(): void
Once the freeable objects being managed are no longer being accessed, call this method.

Returns void
- Defined in packages/util/src/freeable.ts:24

manage

manage<T>(freeable: T): T
Objects passed to this method will then be managed by the instance.

Returns
The freeable object passed in, which can be undefined.
Type Parameters
- T extends undefined | Freeable
Parameters
- freeable: T
  
  An object with a free function, or undefined. This makes it suitable for wrapping functions that may or may not return a value, to minimise the implementation logic.
Returns T
- Defined in packages/util/src/freeable.ts:16

Generated using TypeDoc