screeps-api
    Preparing search index...

    Interface ScreepsServerConfig

    Normalized configuration for a single Screeps World server

    ScreepsRawServerConfig for the pre-normalized schema

    interface ScreepsServerConfig {
        email?: string;
        password?: string;
        token?: string;
        url: string;
    }
    Index

    Properties

    email? password? token? url

    Properties

    email?: string

    The email address or username with which to authenticate on this server.

    This is ignored if token is defined.

    If the server does not support email/pasword authentication (ex: official servers), token must be used instead.

    password?: string

    The password with which to authenticate on this server.

    This is ignored if token is defined.

    If the server does not support email/pasword authentication (ex: official servers), token must be used instead.

    token?: string

    The API authentication token to use with this server.

    If this is not provided, email and password must be set instead.

    url: string

    The base URL for the API. Do not include /api in the path; it will be appended automatically

    Settings

    Member Visibility

    On This Page

    Properties