Skip to content

Documentation / @ripl/core / Disposer

Abstract Class: Disposer

Defined in: packages/core/src/core/disposer.ts:6

Abstract base class that manages disposable resources, supporting keyed retention and bulk disposal.

Extended by

Constructors

Constructor

new Disposer(): Disposer

Returns

Disposer

Properties

PropertyModifierTypeDescriptionDefined in
defaultKeyreadonlytypeof defaultKeyThe key under which resources are retained when no explicit key is provided.packages/core/src/core/disposer.ts:11

Methods

dispose()

protected dispose(key?): void

Defined in: packages/core/src/core/disposer.ts:25

Disposes all resources under the given key, or all resources if no key is provided.

Parameters

ParameterType
key?PropertyKey

Returns

void


retain()

protected retain(value, key?): void

Defined in: packages/core/src/core/disposer.ts:14

Registers a disposable resource under an optional key for later cleanup.

Parameters

ParameterTypeDefault value
valueDisposableundefined
keyPropertyKeyDisposer.defaultKey

Returns

void