@triply/triplydb
    Preparing search index...

    Interface AppConfig

    interface AppConfig {
        httpProxy?: string;
        httpsProxy?: string;
        token?: string;
        url?: string;
    }
    Index
    httpProxy?: string

    Proxy to route plain HTTP requests through.

    Applied by installing a global agent, because parts of this library reach the network through modules that accept no per-request proxy. Setting either proxy therefore affects the whole process, not only this object.

    httpsProxy?: string

    Proxy to route HTTPS requests through.

    When both are given this one is used for HTTP as well, so it wins over AppConfig.httpProxy. See there for the process-wide effect.

    token?: string

    API token, created in a TriplyDB instance under your user settings.

    Without one you can still read public data. With one, every request is made as the token's owner, and App.getUser and App.getAccount can be called with no name to mean "whoever this token belongs to".

    A token also names the instance that issued it, which is why AppConfig.url is optional.

    A token containing characters outside the ASCII range headers allow makes App.get throw immediately. A token that is not a decodable JWT does too, but only when AppConfig.url is left unset — that is the case where the URL has to come from the token.

    url?: string

    URL of the TriplyDB API to talk to, for example https://api.triplydb.com.

    Optional, because a AppConfig.token carries the instance that issued it: pass a token and leave this unset, and the URL comes from the token — so a token for a private instance connects to that instance without naming it twice. Set it explicitly to read public data with no token, where it otherwise defaults to https://api.triplydb.com.

    One asymmetry to know about: the token only fills this in when it is unset or set to exactly that default, so writing url: "https://api.triplydb.com" does not pin the URL against a token issued elsewhere. Any other value does take precedence over the token.

    A trailing slash is removed.