Type Alias ApiOptions

Api connection options

type ApiOptions = {
    bundleTime?: number;
    legacyDates?: boolean;
    origin?: string;
    saveSession?: boolean;
    socket?: false | string;
}

Properties

bundleTime?: number

Bundle requests together that happen in quick succession

legacyDates?: boolean

Use legacy dates by default

origin?: string

Name of client for logging

saveSession?: boolean

Save session token to localStorage to persist logins

socket?: false | string

Disable sockets with false or override socket URL