A11 TypeScript API - v0.7.26
    Preparing search index...

    Interface ActionBinding

    Worker operations used by the typed action convenience.

    interface ActionBinding {
        id: string;
        name: string;
        call(): Promise<unknown>;
        cancel(): Promise<unknown>;
        containsPort(name: string): Promise<boolean>;
        exposeStreamSources(port: string, purpose: string): Promise<void>;
        getHeader(name: string): Promise<string | null>;
        hasHeader(name: string): Promise<boolean>;
        headers(): Promise<Record<string, string>>;
        input(name: string, bindStream?: boolean): Promise<NodeBinding>;
        log(chunk: Record<string, unknown>): Promise<void>;
        logNode(): Promise<NodeBinding>;
        makeNested(
            name: string,
            options?: {
                forwardHeaders?: boolean;
                id?: string;
                propagateIo?: boolean;
                schema?: Record<string, unknown>;
            },
        ): Promise<ActionBinding>;
        node(id: string): Promise<NodeBinding>;
        output(name: string, bindStream?: boolean): Promise<NodeBinding>;
        port(name: string): Promise<NodeBinding>;
        ready(): Promise<unknown>;
        registerStream(
            purpose: string,
            source: Record<string, unknown>,
            producerId?: string,
            parentProducerId?: string,
        ): Promise<Record<string, unknown>>;
        release(): Promise<unknown>;
        removeHeader(name: string): Promise<unknown>;
        resolveNode(reference: Record<string, unknown>): Promise<NodeBinding>;
        run(): Promise<unknown>;
        schema(): Promise<Record<string, unknown>>;
        sessionId(): Promise<string | null>;
        setHeader(name: string, value: string): Promise<unknown>;
        setSettings(settings: ActionSettings): Promise<unknown>;
        settings(): Promise<Record<string, unknown>>;
        state(): Promise<
            {
                called: boolean;
                dispatchStatus?: Status;
                done: boolean;
                run: boolean;
                status: Status;
            },
        >;
        streamSourcesNode(requestPayload?: boolean): Promise<NodeBinding>;
        wait(options?: { timeoutMs?: number }): Promise<unknown>;
        waitForDispatch(options?: { timeoutMs?: number }): Promise<Status>;
    }
    Index
    id: string
    name: string
    • Parameters

      • name: string

      Returns Promise<boolean>

    • Parameters

      • port: string
      • purpose: string

      Returns Promise<void>

    • Parameters

      • name: string

      Returns Promise<string | null>

    • Parameters

      • name: string

      Returns Promise<boolean>

    • Returns Promise<Record<string, string>>

    • Parameters

      • chunk: Record<string, unknown>

      Returns Promise<void>

    • Parameters

      • name: string
      • Optionaloptions: {
            forwardHeaders?: boolean;
            id?: string;
            propagateIo?: boolean;
            schema?: Record<string, unknown>;
        }

      Returns Promise<ActionBinding>

    • Parameters

      • purpose: string
      • source: Record<string, unknown>
      • OptionalproducerId: string
      • OptionalparentProducerId: string

      Returns Promise<Record<string, unknown>>

    • Parameters

      • name: string

      Returns Promise<unknown>

    • Returns Promise<Record<string, unknown>>

    • Parameters

      • name: string
      • value: string

      Returns Promise<unknown>

    • Returns Promise<Record<string, unknown>>

    • Returns Promise<
          {
              called: boolean;
              dispatchStatus?: Status;
              done: boolean;
              run: boolean;
              status: Status;
          },
      >

    • Parameters

      • Optionaloptions: { timeoutMs?: number }

      Returns Promise<unknown>