Class BaseAPI

This is the base class for all generated API classes.

Hierarchy (view full)

BaseAPI

Index

Constructors

Properties

Methods

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

Methods

`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
- OptionalinitOverrides: 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: ResponseContext) => 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: RequestContext) => Promise<void | FetchParams>)[]
Returns T
- Defined in src/runtime.ts:107