Class JsonClientSupport<API, T>`Abstract`

An abstract class for JSON client support.

Type Parameters

API extends UrlHelper
the URL helper type
T
the result data type

Hierarchy (View Summary)

JsonClientSupport

Index

Constructors

Properties

api authBuilder?

Methods

fetch requestor

Constructors

constructor

new JsonClientSupport<API extends UrlHelper, T>(
api: API,
authBuilder?: AuthorizationV2Builder,
): JsonClientSupport<API, T>
Constructor.

If api is a Net.SolarQueryApi and no authBuilder is provided, the Net.SolarQueryApi#publicQuery property will be automatically set to true.
Type Parameters
- API extends UrlHelper
- T
Parameters
- api: API
  the URL helper to use
- OptionalauthBuilder: AuthorizationV2Builder
  the auth builder to authenticate requests with; if not provided then only public data can be queried
Returns JsonClientSupport<API, T>
- Defined in src/main/net/jsonClientSupport.ts:36

Properties

`Protected` `Readonly`api

api: API

The URL helper 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 src/main/net/jsonClientSupport.ts:49

`Protected`requestor

requestor<V>(
    url: string,
    signUrl?: string,
    delay?: number,
): (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)
- Optionaldelay: number
  an optional number of milliseconds to sleep before initiating the request
Returns (cb: LoaderDataCallbackFn<V>) => void
a function that accepts a callback argument
- Defined in src/main/net/jsonClientSupport.ts:61