footprintjs - v11.2.0
    Preparing search index...

    Interface ReactiveTarget

    interface ReactiveTarget {
        addDebugInfo(key: string, value: unknown): void;
        addDebugMessage(value: unknown): void;
        addErrorInfo(key: string, value: unknown): void;
        addEval(name: string, value: unknown): void;
        addMetric(name: string, value: unknown): void;
        attachScopeRecorder(recorder: ScopeRecorder): void;
        call<R>(
            target: string,
            fn: (attempt: AttemptContext) => R | Promise<R>,
            policy?: RetryPolicy,
            options?: CallOptions,
        ): Promise<R>;
        deleteValue(key: string, description?: string): void;
        detachAndForget(
            driver: DetachDriver,
            child: FlowChart,
            input?: unknown,
        ): void;
        detachAndJoinLater(
            driver: DetachDriver,
            child: FlowChart,
            input?: unknown,
        ): DetachHandle;
        detachScopeRecorder(recorderId: string): void;
        emitEvent(name: string, payload?: unknown): void;
        getArgs<T = Record<string, unknown>>(): T;
        getAttempt(): AttemptContext;
        getEnv(): Readonly<ExecutionEnv>;
        getScopeRecorders(): ScopeRecorder[];
        getStateKeys?(): string[];
        getValue(key?: string): unknown;
        getValueSilent?(key?: string): unknown;
        hasKey?(key: string): boolean;
        listsKey?(key: string): boolean;
        setValue(
            key: string,
            value: unknown,
            shouldRedact?: boolean,
            description?: string,
        ): void;
        updateValue(key: string, value: unknown, description?: string): void;
    }
    Index
    addDebugInfo addDebugMessage addErrorInfo addEval addMetric attachScopeRecorder call deleteValue detachAndForget detachAndJoinLater detachScopeRecorder emitEvent getArgs getAttempt getEnv getScopeRecorders getStateKeys? getValue getValueSilent? hasKey? listsKey? setValue updateValue

    • Parameters

      • key: string
      • value: unknown

      Returns void

    • Parameters

      • key: string
      • value: unknown

      Returns void

    • Parameters

      • name: string
      • value: unknown

      Returns void

    • Parameters

      • name: string
      • value: unknown

      Returns void

    • Parameters

      • key: string
      • Optionaldescription: string

      Returns void

    • Parameters

      • recorderId: string

      Returns void

    • Parameters

      • name: string
      • Optionalpayload: unknown

      Returns void

    • Returns all state keys without firing onRead. Used by ownKeys/has traps.

      Returns string[]

    • Read state without firing onRead. Used by array proxy getCurrent() and, since 9.22.0, by every nested / element / terminal proxy's LIVE read (liveView.ts). A target without it falls back to the tracked read, so each nested access then fires onRead — provide it (ScopeFacade does).

      Parameters

      • Optionalkey: string

      Returns unknown

    • Check key existence without firing onRead. Used by has trap.

      Parameters

      • key: string

      Returns boolean

    • hasKey for the descriptor trap: a step of a listing, which hands the stage no value. Falls back to hasKey.

      Parameters

      • key: string

      Returns boolean

    • Parameters

      • key: string
      • value: unknown
      • OptionalshouldRedact: boolean
      • Optionaldescription: string

      Returns void

    • Parameters

      • key: string
      • value: unknown
      • Optionaldescription: string

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods