Briyah SDK - v2.0.6
    Preparing search index...

    Interface ToolHelpers

    interface ToolHelpers {
        fetch: {
            (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
            (input: string | URL | Request, init?: RequestInit): Promise<Response>;
        };
        illustration?: ToolIllustration;
        packDocuments?: ToolPackDocuments;
        room?: ToolRoomAccess;
    }
    Index
    fetch illustration? packDocuments? room?
    fetch: {
        (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
        (input: string | URL | Request, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

      • (input: URL | RequestInfo, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: URL | RequestInfo
        • Optionalinit: RequestInit

        Returns Promise<Response>

      • (input: string | URL | Request, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | URL | Request
        • Optionalinit: RequestInit

        Returns Promise<Response>

    illustration?: ToolIllustration

    Asking the room to illustrate itself. Absent when there is no room, and when the host wired no illustration service — a tool that needs it should say so rather than dereferencing it.

    packDocuments?: ToolPackDocuments

    The documents installed packs ship. Absent when the host wired no artifact store into the tool execution service, which today means a unit test.

    room?: ToolRoomAccess

    Access to the room the calling agent is in. Absent when there is no room, which today means the tool-test endpoint. Tools that need it should fail with a clear message rather than dereferencing it.

    Settings
    Member Visibility

    On This Page
    Properties