@quantcdn/quant-client v2.0.11

QuantCDN client API

Provides a client to common API interfaces on QuantCDN.

Install

The preferred method for installation is via npm.

npm i @quantcdn/quant-client

Usage

• Import types form '@quantcdn/quant-client' to correctly type parameters
• All responses are generated using the PaginatedResponse object which provides an async iterator

import { QuantClient, types } from '@quantcdn/quant-client'

const config:types.Config = {
  organization: process.env.QUANT_CUSTOMER,
  project: process.env.QUANT_PROJECT,
  token: process.env.QUANT_TOKEN
}

// If making organization API requests with the client you need to provide bearer
# config.bearer = process.env.QUANT_BEARER_TOKEN

// Create a new client instance.
const client = new QuantClient(config)

// Perform requests to the project API.
const p:types.URLPayload = {"url": "/*"}
client.project.purge(p).then(async res => {
   const r = await res.first()
   console.log(r)
})

// Ping the API to verify details.
client.project.ping().then(async res => {
  const b = await res.first()
  console.log(b)
})

// Access project metadata.
client.project.meta().then(async res => {
  // res.first() will return the first page of the paginated response.
  for await (const i of res) {
    console.log(i)
  }
})

Available methods

The QuantClient class has three properties to access different APIs that are exposed by Quant. These are project, organization, search. Both the project and search clients are project specific.

client.project

client.organization

client.search