Interface IConfig

The configuration options for instantiating a new Reader.

interface IConfig {
    url: string;
    client?: string;
    autoPostToken?: boolean;
}

Properties

url: string

The base API URL. The main (/reader/api/0/) and auth (/accounts/ClientLogin) endpoint paths will be appended.

client?: string

The name to identify as when making requests. Default: libseymour.

autoPostToken?: boolean

Whether to automatically call Reader#getPostToken and attempt to retry API requests that result in a 400 or 401 response. Default: true