Type alias ServerOptions

ServerOptions: {
    host: string;
    integrations?: GoogleCloudIntegrations;
    keepAliveTimeout?: number;
    logLevel: LogLevel;
    mode: Runtime;
    name: string;
    port: number;
    requestAuthentication?: RequestAuthentication;
}

Options to configure a server.

Type declaration

  • Readonly host: string

    The hostname to which the server should bind.

  • Optional Readonly integrations?: GoogleCloudIntegrations

    Configuration for various Google Cloud agents that can aid debugging.

  • Optional Readonly keepAliveTimeout?: number

    Optional value in milliseconds for keepalive timeout of the server. For running in Google Cloud, this should be higher than the load balancer's own keepalive timeout value, which at time of writing was indicated to be 80000ms [1].

    [1] https://khanacademy.slack.com/archives/CJSE4TMQX/p1573252787333500

    Defaults to 90000.

  • Readonly logLevel: LogLevel

    The log level at which to log things. Anything at or more serious than this level will be logged.

  • Readonly mode: Runtime

    What runtime mode the server is running under.

  • Readonly name: string

    The name of the server.

  • Readonly port: number

    The port on which the server should listen.

  • Optional Readonly requestAuthentication?: RequestAuthentication

    Configuration information for authenticating requests.

Settings

Member Visibility

Theme

Generated using TypeDoc