Files
58c2c80401 Migrate from Yarn to pnpm (#246)
* Migrate from Yarn to pnpm

- Replace Yarn 4.0.2 with pnpm 10.29.3 as the package manager
- Add pnpm-workspace.yaml and .npmrc configuration
- Update all scripts to use pnpm commands
- Rename getYarnWorkspaces() to getWorkspaces() in scripts/helpers.ts
- Update CI workflow to use pnpm/action-setup@v4 with Node 22
- Add @jitl/tsconfig as root devDependency for proper resolution
- Add variant packages as devDependencies for test resolution
- Fix TypeScript 5.9 compatibility in memory.ts (Int32Array<ArrayBuffer>)
- Upgrade typedoc to 0.28.17 for TypeScript 5.9 support
- Upgrade typedoc-plugin-markdown to 4.10.0
- Regenerate documentation with new typedoc version

* Clarify git commit --amend rule in CLAUDE.md

* CI: Add --ignore-scripts to pnpm install

Equivalent to yarn's YARN_ENABLE_SCRIPTS=0 - prevents prepare scripts
from running during install, which would fail on a fresh checkout.

* Fix pnpm tarball naming in smoketest scripts

pnpm pack generates tarball names like jitl-quickjs-ffi-types-0.32.0.tgz
(without @ prefix, with version) instead of @jitl-quickjs-ffi-types.tgz

* Update examples to TypeScript 5.9 for compatibility

The library now requires TypeScript 5.9+ due to stricter typed array
generics (Int32Array<ArrayBuffer>). Update all TypeScript-using examples.

* Use --legacy-peer-deps for create-react-app smoketest

react-scripts@5 only supports TypeScript 3.x/4.x, but our library now
requires TypeScript 5.9+ for typed array generics. Use --legacy-peer-deps
to work around the peer dependency conflict.

* Fix formatting issues

* Fix remaining formatting issues

* Add reminder to run prettier and lint before pushing

* Document CI workflow in CLAUDE.md

* Add typedoc.json and remark plugins for in-page table of contents

- Add typedoc-plugin-remark, remark-toc, and remark-insert-headings
- Configure remark plugins to generate "Contents" section for Class,
  Interface, Enum, TypeAlias, and Function pages
- This restores the in-page TOC that lists methods/properties that was
  removed in typedoc-plugin-markdown 4.3.0

* Use custom remark plugin for headless TOC in docs

Replace remark-insert-headings + remark-toc with a custom plugin that
inserts the table of contents directly after the class description,
without a separate "Contents" heading.

* Revert to standard remark plugins for TOC with Contents heading

Use remark-insert-headings + remark-toc instead of custom plugin.
Remove mdast-util-toc dependency and custom remark-toc-headless.mjs.

* Fix lockfile - remove mdast-util-toc

* Ignore pnpm-lock.yaml in prettier, update .yarn to .pnpm

---------

Co-authored-by: Hanzo Dev <[email protected]>
2026-02-16 20:35:52 +00:00

5.0 KiB

quickjs-emscripten


quickjs-emscripten / quickjs-emscripten-core / Scope

Class: Scope

Defined in: packages/quickjs-emscripten-core/src/lifetime.ts:265

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

Contents

Extends

Implements

Constructors

Constructor

new Scope(): Scope

Returns

Scope

Inherited from

UsingDisposable.constructor

Accessors

alive

Get Signature

get alive(): boolean

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

Returns

boolean

true if the object is alive

Implementation of

Disposable.alive

Overrides

UsingDisposable.alive

Methods

[dispose]()

[dispose](): void

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

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

Returns

void

Implementation of

Disposable.[dispose]

Inherited from

UsingDisposable.[dispose]


dispose()

dispose(): void

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

Dispose of the underlying resources used by this object.

Returns

void

Implementation of

Disposable.dispose

Overrides

UsingDisposable.dispose


manage()

manage<T>(lifetime): T

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

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

Type Parameters

T

T extends Disposable

Parameters

lifetime

T

Returns

T


withScope()

static withScope<R>(block): R

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

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

R

Parameters

block

(scope) => R

Returns

R

Warning

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


withScopeAsync()

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

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

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

R

Parameters

block

(scope) => Promise<R>

Returns

Promise<R>


withScopeMaybeAsync()

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

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

Type Parameters

Return

Return

This

This

Yielded

Yielded

Parameters

_this

This

block

MaybeAsyncBlock<Return, This, Yielded, [Scope]>

Returns

Return | Promise<Return>