Class ScopeExitHandle<Callback>

The handle returned from scopeExit that allows calling or skipping the provided onExit function.

Calling .call() will call the provided onExit function immediately, and prevent it from being called again.

Calling .skip() will prevent the onExit function from being called.

If neither .call() nor .skip() is called, the onExit function will be called automatically when the handle is disposed.

Type Parameters

const Callback extends () => Promise<void> | void

Index

Accessors

Methods

[asyncDispose] [dispose] call skip

Accessors

called

get called(): boolean
Whether the onExit function has been called

Returns boolean
- Defined in ScopeExit.ts:24

skipped

get skipped(): boolean
Whether the onExit function has been skipped

Returns boolean
- Defined in ScopeExit.ts:29

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
- Defined in ScopeExit.ts:60

[dispose]

"[dispose]"(): void
Returns void
- Defined in ScopeExit.ts:56

call

call(): void | ReturnType<Callback>
Call the onExit function immediately if it has not been called or skipped yet, and prevent it from being called again.

Returns void | ReturnType<Callback>
- Defined in ScopeExit.ts:36

skip

skip(): void
Prevent the onExit function from being called if it has not been called yet

Returns void
- Defined in ScopeExit.ts:48