Interface Options

Configuration for the API.

Hierarchy

  • Options

Properties

agent apiKey appId cookieSameSite? cookiesDomain? disableSecureCookies? loginCookieName loginStateCookieName realm

Properties

agent

agent: ((method: string, location: string) => SuperAgentRequest)

Type declaration

    • (method: string, location: string): SuperAgentRequest

    • Superagent-like agent. Pass your own instance of superagent or supertest.

      Returns

      SuperAgentRequest

      Parameters

      • method: string

        method

      • location: string

        url

      Returns SuperAgentRequest

apiKey

apiKey: string

API key from the dashboard.

appId

appId: string

Your appId. Automatically inferred from apiKey.

Optional cookieSameSite

cookieSameSite?: boolean | "lax" | "strict" | "none"

Override the SameSite attribute for authentication cookies.

Optional cookiesDomain

cookiesDomain?: string

Dictates the Domain attribute for authentication cookies.

Example: '.example.com'

Optional disableSecureCookies

disableSecureCookies?: boolean

Disable secure cookies. Will only take effect if process.env.NODE_ENV === 'development'.

loginCookieName

loginCookieName: string

Name for the login cookie (optional).

loginStateCookieName

loginStateCookieName: string

Name for the login state cookie (optional)

realm

realm: Realm

Configures the URL of the unolog·in API.

Settings

Member Visibility

Theme

Generated using TypeDoc