screeps-api
    Preparing search index...

    Interface ScreepsRawServerConfig

    Server configuration schema from ScreepsJsonConfig/ScreepsYamlConfig.

    ScreepsConfigManager will convert this into its normalized form ScreepsServerConfig before using it.

    interface ScreepsRawServerConfig {
        email?: string;
        host?: string;
        hostname?: string;
        password?: string;
        path?: string;
        pathname?: string;
        port?: string | number;
        protocol?: "http" | "https";
        ptr?: boolean;
        season?: boolean;
        secure?: boolean;
        token?: string;
        url?: string;
        username?: string;
    }
    Index

    Properties

    email? host? hostname? password? path? pathname? port? protocol? ptr? season? secure? token? url? username?

    Properties

    email?: string

    ScreepsServerConfig.email

    host?: string

    Treated as an alias of hostname.

    hostname?: string

    Host name portion of url.

    This is ignored if url is defined.

    URL.hostname

    password?: string

    ScreepsServerConfig.password

    path?: string

    Treated as an alias of pathname.

    pathname?: string

    Path portion of url.

    This is ignored if url is defined.

    URL.pathname

    port?: string | number

    Port portion of url.

    This is ignored if url is defined.

    URL.port

    protocol?: "http" | "https"

    Protocol portion of url.

    This is ignored if url is defined.

    URL.protocol

    ptr?: boolean

    Sets pathname to /ptr. On the screeps.com host, this is the path of the Public Test Realm (PTR) server.

    This is ignored if url, path, or pathname is defined.

    season?: boolean

    Sets pathname to /season. On the screeps.com host, this is the path of the Seasonal World server.

    This is ignored if url, path, or pathname is defined.

    secure?: boolean

    If this is set and protocol is undefined, sets protocol to https.

    This is ignored if url is defined.

    token?: string

    ScreepsServerConfig.token

    url?: string

    ScreepsServerConfig.url

    username?: string

    Treated as an alias of email.

    Settings

    Member Visibility

    On This Page

    Properties