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

    Interface GraphBinding

    Stable worker bridge consumed by the SDK's native graph conveniences.

    interface GraphBinding {
        action(
            name: string,
            id?: string,
            sessionId?: string,
            streamId?: string,
            settings?: ActionSettings,
            schema?: Record<string, unknown>,
        ): ActionBinding;
        actionRegistryHas(name: string): Promise<boolean>;
        actionRegistryMessage(
            name: string,
            actionId?: string,
        ): Promise<Record<string, unknown>>;
        actionRegistryNames(): Promise<string[]>;
        actionRegistrySchema(name: string): Promise<Record<string, unknown>>;
        discardNode(id: string): Promise<boolean>;
        hasNode(id: string): Promise<boolean>;
        node(id: string): NodeBinding;
        nodeMapIds(): Promise<string[]>;
        nodeMapSize(): Promise<number>;
        registerRunnableAction(
            schema: Record<string, unknown>,
            handler: (
                action: ActionBinding,
                context: { signal?: AbortSignal },
            ) => Promise<void | Status>,
        ): Promise<() => Promise<void>>;
        registerSchema(
            schema: Record<string, unknown>,
        ): Promise<() => Promise<void>>;
        resolveNode(reference: Record<string, unknown>): Promise<{ id: string }>;
        session(
            id?: string,
            options?: Record<string, unknown>,
            callbacks?: {
                onDone?: (stream: WireStream) => Promise<void | Status>;
                onMessage?: (
                    message: Record<string, unknown> | null,
                    stream: WireStream,
                ) => Promise<void | Status>;
            },
        ): SessionBinding;
        unregisterRegisteredAction(name: string): Promise<void>;
    }

    Hierarchy (View Summary)

    Index
    • Parameters

      • name: string
      • Optionalid: string
      • OptionalsessionId: string
      • OptionalstreamId: string
      • Optionalsettings: ActionSettings
      • Optionalschema: Record<string, unknown>

      Returns ActionBinding

    • Parameters

      • name: string

      Returns Promise<boolean>

    • Parameters

      • name: string
      • OptionalactionId: string

      Returns Promise<Record<string, unknown>>

    • Parameters

      • name: string

      Returns Promise<Record<string, unknown>>

    • Parameters

      • id: string

      Returns Promise<boolean>

    • Parameters

      • id: string

      Returns Promise<boolean>

    • Parameters

      • schema: Record<string, unknown>
      • handler: (
            action: ActionBinding,
            context: { signal?: AbortSignal },
        ) => Promise<void | Status>

      Returns Promise<() => Promise<void>>

    • Parameters

      • schema: Record<string, unknown>

      Returns Promise<() => Promise<void>>

    • Parameters

      • reference: Record<string, unknown>

      Returns Promise<{ id: string }>

    • Parameters

      • Optionalid: string
      • Optionaloptions: Record<string, unknown>
      • Optionalcallbacks: {
            onDone?: (stream: WireStream) => Promise<void | Status>;
            onMessage?: (
                message: Record<string, unknown> | null,
                stream: WireStream,
            ) => Promise<void | Status>;
        }

      Returns SessionBinding

    • Parameters

      • name: string

      Returns Promise<void>