Class ApiConfiguration

Hierarchy

  • Configuration
    • ApiConfiguration

Constructors

constructor

Properties

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

Methods

isJsonMime

Constructors

constructor

  • new ApiConfiguration(param?): ApiConfiguration

  • Parameters

    • Optionalparam: ConfigurationParameters

    Returns ApiConfiguration

Properties

OptionalapiKey

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

parameter for apiKey security

Param: name

security name

Memberof

Configuration

Optionalusername

username?: string

parameter for basic security

Memberof

Configuration

Optionalpassword

password?: string

parameter for basic security

Memberof

Configuration

OptionalaccessToken

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

parameter for oauth2 security

Param: name

security name

Param: scopes

oauth2 scope

Memberof

Configuration

OptionalbasePath

basePath?: string

override base path

Memberof

Configuration

OptionalbaseOptions

baseOptions?: any

base options for axios calls

Memberof

Configuration

OptionalformDataCtor

formDataCtor?: (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.

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

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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods