SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface SoulFireOptions

    Connection options for an existing SoulFire gRPC-Web server.

    The Minecraft address belongs to instance or bot provisioning, not baseUrl.

    interface SoulFireOptions {
        baseUrl: string;
        defaultTimeoutMs?: number;
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        interceptors?: Interceptor[];
        requiredCapabilities?: readonly string[];
        requiredPlugins?: readonly RequiredPluginRequirement[];
        token?: string
        | TokenProvider;
        transport?: Transport;
    }
    Index
    baseUrl defaultTimeoutMs? fetch? interceptors? requiredCapabilities? requiredPlugins? token? transport?
    baseUrl: string

    SoulFire gRPC-Web URL, including its scheme. This is not the Minecraft address.

    defaultTimeoutMs?: number

    Default RPC timeout in milliseconds, separate from bot readiness or task deadlines.

    fetch?: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }

    Type Declaration

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

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>

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

      • MDN Reference

        Parameters

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

        Returns Promise<Response>

    interceptors?: Interceptor[]
    requiredCapabilities?: readonly string[]

    Capability identifiers that must be present in the handshake.

    requiredPlugins?: readonly RequiredPluginRequirement[]

    Plugin identifiers and version constraints that must pass the handshake.

    token?: string | TokenProvider

    Bearer token or provider evaluated before each request. Omit for a public server.

    transport?: Transport

    Custom Connect transport. Its caller configures authentication and transport timeouts.

    Settings
    Member Visibility

    On This Page
    Properties