Documentation

Configuration

Constructors

Constructor

Properties

Optional Access Token

  • 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 Api Key

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

parameter for apiKey security

param

security name

memberof

Configuration

Optional Base Options

  • baseOptions: any

base options for axios calls

memberof

Configuration

Optional Base Path

  • basePath: string

override base path

memberof

Configuration

Optional Form Data Ctor

  • 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

Optional Password

  • password: string

parameter for basic security

memberof

Configuration

Optional Username

  • username: string

parameter for basic security

memberof

Configuration

Methods

Is Json Mime

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