Class PoolsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

getPools getPoolsRaw getPoolsWithPoolId getPoolsWithPoolIdRaw isJsonMime request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

getPools

  • getPools(requestParameters?, initOverrides?): Promise<Pools>

  • Returns Pools Data Get cwmsData pools

    Parameters

    Returns Promise<Pools>

getPoolsRaw

getPoolsWithPoolId

  • getPoolsWithPoolId(requestParameters, initOverrides?): Promise<Pool>

  • Retrieves requested Pool Get cwmsData pools with poolId

    Parameters

    Returns Promise<Pool>

getPoolsWithPoolIdRaw

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.

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationgetPoolsgetPoolsRawgetPoolsWithPoolIdgetPoolsWithPoolIdRawisJsonMimerequestwithMiddlewarewithPostMiddlewarewithPreMiddleware