Configuration

Constructors

new Configuration()

new Configuration(param): Configuration

Parameters

param

Returns

Properties

accessToken?

optional accessToken: string | Promise<string> | (name?, scopes?) => string | (name?, scopes?) => Promise<string>

parameter for oauth2 security

Param

security name

Param

oauth2 scope

Memberof

Configuration


apiKey?

optional apiKey: string | Promise<string> | (name) => string | (name) => Promise<string>

parameter for apiKey security

Param

security name

Memberof

Configuration


baseOptions?

optional baseOptions: any

base options for axios calls

Memberof

Configuration


basePath?

optional basePath: string

override base path

Memberof

Configuration


formDataCtor()?

optional formDataCtor: () => any

The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.

The FormData constructor that will be used to create multipart form data requests. You can inject this here so that execution environments that do not support the FormData class can still run the generated client.

Returns

any


password?

optional password: string

parameter for basic security

Memberof

Configuration


serverIndex?

optional serverIndex: number

override server index

Memberof

Configuration


username?

optional username: string

parameter for basic security

Memberof

Configuration

Methods

isJsonMime()

isJsonMime(mime): boolean

Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json

Parameters

mime

string

MIME (Multipurpose Internet Mail Extensions)

Returns

boolean

True if the given MIME is JSON, false otherwise.

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.