Skip to content

Latest commit

 

History

History
227 lines (123 loc) · 5.06 KB

Scope.md

File metadata and controls

227 lines (123 loc) · 5.06 KB

quickjs-emscripten • quickjs-emscripten-core • Readme | Exports

quickjs-emscripten / quickjs-emscripten-core / Scope

Class: Scope

Scope helps reduce the burden of manually tracking and disposing of Lifetimes. See withScope. and withScopeAsync.

Contents

Extends

Implements

Constructors

new Scope(undefined)

new Scope(): Scope

Returns

Scope

Inherited from

quickjs-emscripten-core.UsingDisposable.constructor

Accessors

alive

get alive(): boolean

Returns

boolean

true if the object is alive

false after the object has been disposed

Source

packages/quickjs-emscripten-core/src/lifetime.ts:333

Methods

[dispose]()

[dispose](): void

Just calls the standard .dispose() method of this class.

Returns

void

Implementation of

quickjs-emscripten-core.Disposable.[dispose]

Inherited from

quickjs-emscripten-core.UsingDisposable.[dispose]

Source

packages/quickjs-emscripten-core/src/lifetime.ts:47

dispose()

dispose(): void

Dispose of the underlying resources used by this object.

Returns

void

Implementation of

quickjs-emscripten-core.Disposable.dispose

Overrides

quickjs-emscripten-core.UsingDisposable.dispose

Source

packages/quickjs-emscripten-core/src/lifetime.ts:337

manage()

manage<T>(lifetime): T

Track lifetime so that it is disposed when this scope is disposed.

Type parameters

• T extends Disposable

Parameters

• lifetime: T

Returns

T

Source

packages/quickjs-emscripten-core/src/lifetime.ts:328

withScope()

static withScope<R>(block): R

Run block with a new Scope instance that will be disposed after the block returns. Inside block, call scope.manage on each lifetime you create to have the lifetime automatically disposed after the block returns.

Type parameters

• R

Parameters

• block: (scope) => R

Returns

R

Warning

Do not use with async functions. Instead, use withScopeAsync.

Source

packages/quickjs-emscripten-core/src/lifetime.ts:273

withScopeAsync()

static withScopeAsync<R>(block): Promise<R>

Run block with a new Scope instance that will be disposed after the block's returned promise settles. Inside block, call scope.manage on each lifetime you create to have the lifetime automatically disposed after the block returns.

Type parameters

• R

Parameters

• block: (scope) => Promise<R>

Returns

Promise<R>

Source

packages/quickjs-emscripten-core/src/lifetime.ts:310

withScopeMaybeAsync()

static withScopeMaybeAsync<Return, This, Yielded>(_this, block): Return | Promise<Return>

Type parameters

• Return

• This

• Yielded

Parameters

• _this: This

• block: MaybeAsyncBlock<Return, This, Yielded, [Scope]>

Returns

Return | Promise<Return>

Source

packages/quickjs-emscripten-core/src/lifetime.ts:286

Generated using typedoc-plugin-markdown and TypeDoc