Documentation
    Preparing search index...
    • Type Parameters

      • R extends Registry<any>

      Parameters

      • registry: R
      • OptionalinputConfig: {
            autoConfigureServerless?:
                | boolean
                | {
                    headers?: Record<string, string>;
                    maxRunners?: number;
                    metadata?: Record<string, unknown>;
                    minRunners?: number;
                    requestLifespan?: number;
                    runnersMargin?: number;
                    slotsPerRunner?: number;
                    url?: string;
                };
            basePath?: string;
            defaultServerPort?: number;
            disableActorDriver?: boolean;
            disableDefaultServer?: boolean;
            disableMetadataLookup?: boolean;
            encoding?: "json"
            | "cbor"
            | "bare";
            endpoint?: string;
            fetch?: ExportedHandlerFetchHandler<{ RIVET: Client<any> }, unknown>;
            headers?: Record<string, string>;
            inspector?: {
                defaultEndpoint?: string;
                enabled?: boolean | { actor?: boolean; manager?: boolean };
                token?: (...args: unknown[]) => string;
            };
            logging?: {
                baseLogger?: Logger;
                level?: "fatal"
                | "error"
                | "warn"
                | "info"
                | "debug"
                | "trace"
                | "silent";
            };
            managerPath?: string;
            maxIncomingMessageSize?: number;
            namespace?: string;
            noWelcome?: boolean;
            overrideServerAddress?: string;
            runEngine?: boolean;
            runEngineVersion?: string;
            runnerKey?: string;
            runnerKind?: "serverless"
            | "normal";
            runnerName?: string;
            token?: string;
            totalSlots?: number;
        }
        • OptionalautoConfigureServerless?:
              | boolean
              | {
                  headers?: Record<string, string>;
                  maxRunners?: number;
                  metadata?: Record<string, unknown>;
                  minRunners?: number;
                  requestLifespan?: number;
                  runnersMargin?: number;
                  slotsPerRunner?: number;
                  url?: string;
              }
        • OptionalbasePath?: string
        • OptionaldefaultServerPort?: number
        • OptionaldisableActorDriver?: boolean
        • OptionaldisableDefaultServer?: boolean
        • OptionaldisableMetadataLookup?: boolean
        • Optionalencoding?: "json" | "cbor" | "bare"
        • Optionalendpoint?: string
        • Optionalfetch?: ExportedHandlerFetchHandler<{ RIVET: Client<any> }, unknown>
        • Optionalheaders?: Record<string, string>
        • Optionalinspector?: {
              defaultEndpoint?: string;
              enabled?: boolean | { actor?: boolean; manager?: boolean };
              token?: (...args: unknown[]) => string;
          }
        • Optionallogging?: {
              baseLogger?: Logger;
              level?: "fatal" | "error" | "warn" | "info" | "debug" | "trace" | "silent";
          }
        • OptionalmanagerPath?: string

          Path that the Rivet manager API will be mounted.

        • OptionalmaxIncomingMessageSize?: number
        • Optionalnamespace?: string
        • OptionalnoWelcome?: boolean
        • OptionaloverrideServerAddress?: string
        • OptionalrunEngine?: boolean
        • OptionalrunEngineVersion?: string
        • OptionalrunnerKey?: string
        • OptionalrunnerKind?: "serverless" | "normal"
        • OptionalrunnerName?: string
        • Optionaltoken?: string
        • OptionaltotalSlots?: number

      Returns Handler