Interface Options

interface Options {
    cache?: boolean | CustomCache;
    locale?: string;
    optaOutletAuth?: string;
    optaSecretKey?: string;
}

Index

Properties

cache? locale? optaOutletAuth? optaSecretKey?

Properties

`Optional` cache

cache?: boolean | CustomCache

Whether to allow caching responses.

You may also pass your own custom cache class. See CustomCache.

`Optional` locale

locale?: string

Default locale.

`Optional` optaOutletAuth

optaOutletAuth?: string

OPTA outlet authorisation key.

You may also specify in the environment as OPTA_OUTLET_AUTH.

See OPTA's OAuth guide.

`Optional` optaSecretKey

optaSecretKey?: string

OPTA secret key.

You may also specify in the environment as OPTA_SECRET_KEY.

See OPTA's OAuth guide.