ibl-persisted-queries-client

Client for the Persisted Queries API

Installation

pnpm install @bbc/ibl-persisted-queries-client

Test

pnpm test

To generate a test coverage report:

pnpm run coverage

Usage

const { PersistedQueriesClient } = require('@bbc/ibl-persisted-queries-client');
const client = PersistedQueriesClient.createClient({
  stats: require('@ibl/stats'),
  logger: require('@ibl/logger')
});

const query = await client.getQuery('d9cda751-6b12-442f-a808-9286cdcb8a16');

API

.createClient

Creates a new client.

Parameters

• opts - An options object

Options

createClient supports all of the options supported by ibl-rest-client. A host (string) variable is also supported for setting the API host the client should make calls to.

client.getQuery(id: string)

Parameters

• id - required - The id of the query you wish to retrieve.

Returns

A single query object.

client.getQueries()

Returns

Array of queries.

client.deleteQuery(id: string)

Parameters

• id - required - The id of the query you wish to delete.

Returns

null - if nothing was deleted (404) true - successful delete

client.saveQuery(query: RawQuery)

Parameters

• query - required - The query object to create.

Returns

Query - the serialised query.