SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface SoulFireInstallOptions

    interface SoulFireInstallOptions {
        defaultTimeoutMs?: number;
        directory?: string;
        fetch?: {
            (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
            (input: string | Request | URL, init?: RequestInit): Promise<Response>;
        };
        interceptors?: Interceptor[];
        jarPath?: string;
        javaArgs?: string[];
        javaPath?: string;
        onLog?: (line: string) => void;
        port?: number;
        startupTimeoutMs?: number;
        version?: string;
    }
    Index
    defaultTimeoutMs? directory? fetch? interceptors? jarPath? javaArgs? javaPath? onLog? port? startupTimeoutMs? version?
    defaultTimeoutMs?: number

    Default timeout for unary SDK calls after the server starts.

    directory?: string

    Directory used for the managed JVM, SoulFire JAR, and server data. Defaults to .soulfire below the current working directory.

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

    Custom fetch implementation, primarily for runtimes that do not expose fetch globally.

    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[]

    Additional interceptors applied to the installed server connection.

    jarPath?: string

    Existing SoulFire dedicated server JAR to run instead of downloading a published release. This is useful for release-candidate and source-tree smoke tests.

    javaArgs?: string[]

    Java arguments added before the SoulFire JAR.

    javaPath?: string

    Existing Java 25 executable to use instead of downloading a managed JRE.

    onLog?: (line: string) => void

    Receives lines written by the dedicated server.

    port?: number

    Local gRPC-Web port. Omit this value to select an available port.

    startupTimeoutMs?: number

    Maximum time to wait for SoulFire to finish loading.

    version?: string

    SoulFire release tag. Omit this value to install the latest release.

    Settings
    Member Visibility

    On This Page
    Properties