Type alias QuickBaseOptions

QuickBaseOptions: Partial<{
    appToken: string;
    autoRenewTempTokens: boolean;
    connectionLimit: number;
    connectionLimitPeriod: number;
    errorOnConnectionLimit: boolean;
    proxy: false | {
        auth?: {
            password: string;
            username: string;
        };
        host: string;
        port: number;
    };
    realm: string;
    retryOnQuotaExceeded: boolean;
    server: string;
    tempToken: string;
    tempTokenDbid: string;
    userAgent: string;
    userToken: string;
    version: string;
}>

Type declaration

  • appToken: string

    A Quickbase Application Token

    Only required when using Temporary Tokens

    Quickbase Documentation

  • autoRenewTempTokens: boolean

    Automatically renew Temporary Tokens after they expire

    Default is true

  • connectionLimit: number

    The maximum number of open, pending API connections to Quickbase

    Default is 10

  • connectionLimitPeriod: number

    The period length, in milliseconds, of connection limit

    Default is 1000

  • errorOnConnectionLimit: boolean

    Throw an error if the connection limit is exceeded

    Default is false

  • proxy: false | {
        auth?: {
            password: string;
            username: string;
        };
        host: string;
        port: number;
    }

    Allows the use of a proxy for Quickbase API requests

    Default is false

  • realm: string

    Quickbase Realm.

    For example, if your Quickbase url is: demo.quickbase.com Your realm is: demo

  • retryOnQuotaExceeded: boolean

    Automatically retry if the Quickbase API rate limit is exceeded

    Default is true

  • server: string

    Quickbase API Server FQDN

    Default is api.quickbase.com

  • tempToken: string

    A Temporary Authentication Token or Temporary Table Authentication Token.

    If both a userToken and tempToken are defined, the tempToken will be used

    Quickbase Documentation

  • tempTokenDbid: string

    A Temporary Authentication Token or Temporary Table Authentication Token's Application or Table ID.

    Quickbase Documentation

  • userAgent: string

    Provide a custom User-Agent to help track API usage within your logs

    When used in the browser, this sets the X-User-Agent header instead as the browser will block any attempt to set a custom User-Agent

  • userToken: string

    A Quickbase User Token.

    If both a userToken and tempToken are defined, the tempToken will be used

    Quickbase Documentation

  • version: string

    Quickbase API Version

    Default is v1

Settings

Member Visibility

Theme