E621
    Preparing search index...

    Interface Options<PF>

    interface Options<PF extends PostFormatOptions = NoV2Options> {
        authKey?: string;
        authUser?: string;
        baseURL?: string;
        defaultPostFormat?: PF;
        requestTimeout?: number;
        statusCheckURL?: string;
        userAgent?: string;
        userAgentInQuery?: boolean;
    }

    Type Parameters

    Index
    authKey? authUser? baseURL? defaultPostFormat? requestTimeout? statusCheckURL? userAgent? userAgentInQuery?
    authKey?: string

    The api key you want to authenticate with (Account -> Manage API Access)

    none
    authUser?: string

    The uername of the user you want to authenticate with

    none
    baseURL?: string

    The base URL for the API.

    https://e621.net
    defaultPostFormat?: PF

    The v2/mode format every post-returning method across the lib falls back to when called without explicit v2/mode options (e.g. posts.get(), posts.search(), favorites.search(), popular.get(), iqdbQueries.get()/.post(), and convenience methods on returned post models like post.update()). Per-call options still take priority over this.

    legacy (v2: false)
    requestTimeout?: number

    The number of seconds before a request times out

    30
    statusCheckURL?: string

    The url to use for status checks.

    https://status.e621.church/json
    userAgent?: string

    The user agent to use for requests

    E621/{version} (+https://github.com/DonovanDMC/E621)

    E621/{version} (+https://github.com/DonovanDMC/E621; {authUser})

    userAgentInQuery?: boolean

    Whether to send the user agent in the _client query parameter instead of the User-Agent header. This is useful in browsers, where setting the User-Agent header is not allowed.

    false in Node.js, true in browsers

    Settings
    Member Visibility

    On This Page
    Properties