Class CatalogApi

Hierarchy (view full)

BaseAPI
- CatalogApi

Index

Constructors

Properties

Methods

getCatalogWithDataset getCatalogWithDatasetRaw isJsonMime request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getCatalogWithDataset

getCatalogWithDataset(requestParameters, initOverrides?): Promise<Catalog>
Get cwmsData catalog with dataset
Parameters
- requestParameters: GetCatalogWithDatasetRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Catalog>
- Defined in cwmsjs/src/apis/CatalogApi.ts:121

getCatalogWithDatasetRaw

getCatalogWithDatasetRaw(requestParameters, initOverrides?): Promise<ApiResponse<Catalog>>
Get cwmsData catalog with dataset
Parameters
- requestParameters: GetCatalogWithDatasetRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Catalog>>
- Defined in cwmsjs/src/apis/CatalogApi.ts:56

`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.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

`Protected` request

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

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/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
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/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
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:107