Class JsonClientSupport<T>`Abstract`

An abstract class for JSON client support.

Type Parameters

T

Hierarchy (view full)

JsonClientSupport

Index

Constructors

Properties

api authBuilder?

Methods

fetch requestor

Constructors

constructor

new JsonClientSupport<T>(api, authBuilder?): JsonClientSupport<T>
Constructor.
Type Parameters
- T
Parameters
- api: default
- Optional authBuilder: 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: default

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, signUrl?): ((cb) => 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.
- Optional signUrl: string
  the URL to sign (might be different to url if a proxy is used)
Returns ((cb) => void)
a function that accepts a callback argument
- - (cb): void
  - Parameters
    - cb: LoaderDataCallbackFn<V>
    Returns void
- Defined in jsonClientSupport.ts:60