Class REGIApi

Hierarchy (view full)

BaseAPI
- REGIApi

Index

Constructors

Properties

Methods

getLocationsWithKinds getLocationsWithKindsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getLocationsWithKinds

getLocationsWithKinds(requestParameters?, initOverrides?): Promise<CwmsIdLocationKind[]>
Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields. Get locations withKinds
Parameters
- requestParameters: GetLocationsWithKindsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<CwmsIdLocationKind[]>
- Defined in cwmsjs/src/apis/REGIApi.ts:76

getLocationsWithKindsRaw

getLocationsWithKindsRaw(requestParameters, initOverrides?): Promise<ApiResponse<CwmsIdLocationKind[]>>
Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields. Get locations withKinds
Parameters
- requestParameters: GetLocationsWithKindsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CwmsIdLocationKind[]>>
- Defined in cwmsjs/src/apis/REGIApi.ts:41

`Protected` request

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

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:31

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:42

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:37