brepjs API Reference
    Preparing search index...

    Interface ShapeHandle

    A shape wrapper with Symbol.dispose for auto-cleanup.

    interface ShapeHandle {
        disposed: boolean;
        wrapped: any;
        "[dispose]"(): void;
        delete(): void;
        onDispose(callback: () => void): void;
    }
    Index

    Properties

    disposed: boolean

    Check if this handle has been disposed

    wrapped: any

    The raw kernel shape handle

    Methods

    • Alias for Symbol.dispose — required for Deletable compatibility.

      Returns void

    • Register a callback to run when this handle is disposed, before its kernel slot is released. Used to release dependent resources tied to this shape's lifetime (e.g. its cached sub-shape handles). Callbacks are invoked once, in registration order; a callback that throws is swallowed. Registering on an already-disposed handle runs the callback immediately.

      Parameters

      • callback: () => void

      Returns void