Class EventApi

Hierarchy

BaseAPI
- EventApi

Index

Constructors

Properties

Methods

fireEvent fireEventRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new EventApi(configuration?: Configuration): EventApi
Parameters
- configuration: Configuration = DefaultConfig
Returns EventApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

fireEvent

fireEvent(requestParameters?: FireEventRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Fire an asynchronous event.
Parameters
- requestParameters: FireEventRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/EventApi.ts:66

fireEventRaw

fireEventRaw(requestParameters: FireEventRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Fire an asynchronous event.
Parameters
- requestParameters: FireEventRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/EventApi.ts:37

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in 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
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

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

withPreMiddleware

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

Generated using TypeDoc