Class JsonClientSupport<T>`Abstract`

An abstract class for JSON client support.

Type Parameters

T

Hierarchy (View Summary)

JsonClientSupport

Index

Constructors

Properties

api authBuilder?

Methods

fetch requestor

Constructors

constructor

new JsonClientSupport<T>(
api: SolarQueryApi,
authBuilder?: AuthorizationV2Builder,
): JsonClientSupport<T>
Constructor.
Type Parameters
- T
Parameters
- api: SolarQueryApi
- OptionalauthBuilder: AuthorizationV2Builder
  the auth builder to authenticate requests with; if not provided then only public data can be queried
Returns JsonClientSupport<T>
- Defined in jsonClientSupport.ts:36

Properties

`Protected` `Readonly`api

api: SolarQueryApi

The API instance to use.

`Protected` `Optional` `Readonly`authBuilder

authBuilder?: AuthorizationV2Builder

An authorization builder to use to make authenticated HTTP requests.

Methods

`Abstract`fetch

fetch(): Promise<T>
Asynchronously load the data.

Returns Promise<T>
the result promise
- Defined in jsonClientSupport.ts:49

`Protected`requestor

requestor<V>(
url: string,
signUrl?: string,
): (cb: LoaderDataCallbackFn<V>) => void
Create a URL fetch requestor.

The returned function can be passed to d3.queue or invoked directly.
Type Parameters
- V
Parameters
- url: string
  the URL to request.
- OptionalsignUrl: string
  the URL to sign (might be different to url if a proxy is used)
Returns (cb: LoaderDataCallbackFn<V>) => void
a function that accepts a callback argument
- Defined in jsonClientSupport.ts:60