Class BaseAPI

This is the base class for all generated API classes.

Hierarchy

BaseAPI

Index

Constructors

Properties

configuration middleware

Methods

clone createFetchParams fetchApi request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new BaseAPI(configuration?: Configuration): BaseAPI
Parameters
- configuration: Configuration = DefaultConfig
Returns BaseAPI
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

`Private` middleware

middleware: Middleware[]

Methods

`Private` clone

clone<T>(this: T): 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 work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:220

`Private` createFetchParams

createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<{
init: RequestInit;
url: string;
}>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<{
init: RequestInit;
url: string;
}>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:125

`Private` fetchApi

fetchApi(url: string, init: RequestInit): Promise<Response>
Parameters
- url: string
- init: RequestInit
Returns Promise<Response>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:170

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:116

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: (undefined | ((context: ResponseContext) => Promise<void | Response>))[]
Returns T
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: (undefined | ((context: RequestContext) => Promise<void | FetchParams>))[]
Returns T
- Defined in work/dotHive-postman/dotHive-postman/dothive-sdk-ts/runtime.ts:106

Generated using TypeDoc