Class BaseAPI

This is the base class for all generated API classes.

Hierarchy

BaseAPI
- DefaultApi

Index

Constructors

Properties

configuration middleware jsonRegex

Methods

clone createFetchParams fetchApi isJsonMime request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new BaseAPI(configuration?): BaseAPI
Parameters
- configuration: Configuration = DefaultConfig
Returns BaseAPI
- Defined in src/runtime.ts:97

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

`Private` middleware

middleware: Middleware[]

`Static` `Private` `Readonly` jsonRegex

jsonRegex: RegExp = ...

Methods

`Private` clone

clone<T>(this): T
Create a shallow clone of this by constructing a new instance and then shallow cloning data members.
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
Returns T
- Defined in src/runtime.ts:244

`Private` createFetchParams

createFetchParams(context, initOverrides?): Promise<{
init: RequestInit;
url: string;
}>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<{
init: RequestInit;
url: string;
}>
- Defined in src/runtime.ts:143

`Private` fetchApi

fetchApi(url, init): Promise<Response>
Parameters
- url: string
- init: RequestInit
Returns Promise<Response>
- Defined in src/runtime.ts:194

`Protected` 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.
- Defined in src/runtime.ts:127

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
- Defined in src/runtime.ts:134

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
- Defined in src/runtime.ts:101

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
- Defined in src/runtime.ts:112

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
- Defined in src/runtime.ts:107

Generated using TypeDoc