Class ApiConfiguration

Hierarchy

  • Configuration
    • ApiConfiguration

Constructors

constructor

Properties

apiKey? username? password? accessToken? basePath? baseOptions? formDataCtor?

Methods

isJsonMime

Constructors

constructor

  • Parameters

    • Optional param: ConfigurationParameters

    Returns x.ApiConfiguration

Properties

Optional apiKey

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

parameter for apiKey security

Type declaration

    • (name): string

    • Parameters

      • name: string

      Returns string

Type declaration

    • (name): Promise<string>

    • Parameters

      • name: string

      Returns Promise<string>

Param

security name

Memberof

Configuration

Optional username

username?: string

parameter for basic security

Memberof

Configuration

Optional password

password?: string

parameter for basic security

Memberof

Configuration

Optional accessToken

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

parameter for oauth2 security

Type declaration

    • (name?, scopes?): string

    • Parameters

      • Optional name: string
      • Optional scopes: string[]

      Returns string

Type declaration

    • (name?, scopes?): Promise<string>

    • Parameters

      • Optional name: string
      • Optional scopes: string[]

      Returns Promise<string>

Param

security name

Param

oauth2 scope

Memberof

Configuration

Optional basePath

basePath?: string

override base path

Memberof

Configuration

Optional baseOptions

baseOptions?: any

base options for axios calls

Memberof

Configuration

Optional formDataCtor

formDataCtor?: (new () => any)

Type declaration

    • new (): 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.

      Returns any

Methods

isJsonMime

  • 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc