Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Configuration

Hierarchy

  • Configuration

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional accessToken

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

parameter for oauth2 security

param

security name

param

oauth2 scope

memberof

Configuration

Optional apiKey

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

parameter for apiKey security

param

security name

memberof

Configuration

Optional baseOptions

baseOptions: any

base options for axios calls

memberof

Configuration

Optional basePath

basePath: string

override base path

memberof

Configuration

Optional formDataCtor

formDataCtor: {}

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

Optional httpsAgent

httpsAgent: any

Optional password

password: string

parameter for basic security

memberof

Configuration

Optional username

username: string

parameter for basic security

memberof

Configuration

Methods

isJsonMime

  • isJsonMime(mime: string): 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.

Generated using TypeDoc