Class Client

API Client Instances are created by calling login

Index

Methods

get open_volga_consumer open_volga_producer createInstance

Methods

get

get(path, query_params): Promise<object>
Get data from the API
Parameters
- path: string
  e.g. /v1/state/system/sites
- query_params: undefined | Record<string, string>
  Query parameters to pass
Returns Promise<object>
The resulting object

Common query parameters are:
```
- `{keys: true}` - Only return the names
- `{site: "the-site-name}` - Send the request to a specific site
```
- Defined in avassa.ts:127

open_volga_consumer

open_volga_consumer(opts): VolgaConsumer
Open a volga consumer
Parameters
- opts: OpenConsumer
Returns VolgaConsumer
- Defined in avassa.ts:112

open_volga_producer

open_volga_producer(opts): VolgaProducer
Open a volga producer
Parameters
- opts: OpenProducer
Returns VolgaProducer
- Defined in avassa.ts:105

`Static`createInstance

createInstance(http, token): Client
Internal
Parameters
- http: AxiosInstance
- token: string
Returns Client
- Defined in avassa.ts:98