Type Alias BoxInspectors<T>

Annotation-checking methods on the inspect proxy. Carved out from Inspectors so Box<T> can reference these without dragging in box(): Box<T> — that direct mutual recursion Box ↔ Inspectors blows out TS recursion budgets under typescript-eslint's type-aware mode.

type BoxInspectors<T = unknown> = {
    draft(): T;
    is(operation: Operation): boolean;
    pending(): boolean;
    remaining(): number;
    settled(): Promise<T>;
}

Type Parameters

T = unknown
The type of the value being inspected

Index

Methods

draft is pending remaining settled

Methods

draft

draft(): T
Returns the draft value from the latest annotation, or the actual value from the model

Returns T
- Defined in src/types.ts:88

is

is(operation: Operation): boolean
Returns true if annotation matches the given operation
Parameters
- operation: Operation
Returns boolean
- Defined in src/types.ts:86

pending

pending(): boolean
Returns true if any pending annotations exist

Returns boolean
- Defined in src/types.ts:82

remaining

remaining(): number
Returns the count of pending annotations at this path

Returns number
- Defined in src/types.ts:84

settled

settled(): Promise<T>
Returns a promise that resolves with the value when no more annotations exist at this path

Returns Promise<T>
- Defined in src/types.ts:90