import KintoClient from 'kinto-http'

public class | source

KintoClient

Extends:

KintoClientBase → KintoClient

Test:

KintoClient

Constructor Summary

Public Constructor
public	constructor()

Inherited Summary

From class KintoClientBase
public get	backoff: Number Backoff remaining time, in milliseconds.
public get	remote: String The remote endpoint base URL.
public get	version: String The current server protocol version, eg.
private	_backoffReleaseTime: *
private	_headers: *
private	_isBatch: *
private	_remote: *
private	_requests: *[]
private	_retry: *
private	_safe: *
private	_version: *
public	bucket(name: String, options: Object): Bucket Retrieve a bucket object to perform operations on it.
public	async createBucket(id: String \| null, options: Object): Promise<Object, Error> Creates a new bucket on the server.
public	async fetchHTTPApiVersion(options: Object): Promise<Object, Error> Retrieve authenticated user information.
public	async fetchServerCapabilities(options: Object): Promise<Object, Error> Retrieve server capabilities information.
public	async fetchServerInfo(options: Object): Promise<Object, Error> Retrieves server information and persist them locally.
public	async fetchServerSettings(options: Object): Promise<Object, Error> Retrieves Kinto server settings.
public	async fetchUser(options: Object): Promise<Object, Error> Retrieve authenticated user information.
public	async listBuckets(options: Object): Promise<Object[], Error> Retrieves the list of buckets.
public	async listPermissions(options: Object): Promise<Object[], Error> Lists all permissions.
public	setHeaders(headers: Object) Set client "headers" for every request, updating previous headers (if any).
private	async _batchRequests(requests: Array, options: Object): Promise<Object, Error> Process batch requests, chunking them according to the batch_max_requests server setting when needed.
private	_getHeaders(options: Object): Object Get the value of "headers" for a given request, merging the per-request headers with our own "default" headers.
private	async _getHello(options: Object): Promise<Object, Error> Retrieves the server's "hello" endpoint. This endpoint reveals server capabilities and settings as well as telling the client "who they are" according to their given authorization headers.
private	_getRetry(options: ): As _getSafe, but for "retry".
private	_getSafe(options: Object): Boolean Get the value of "safe" for a given request, using the per-request option if present or falling back to our default otherwise.
private	_registerHTTPEvents() Registers HTTP events.
private	async execute(request: Object, options: Object): Promise<Object, Error> Executes an atomic HTTP request.
private	async paginatedList(path: String, params: Object, options: Object): * Fetch some pages from a paginated list, following the `next-page` header automatically until we have fetched the requested number of pages.

Public Constructors

public constructor() source

Constructor.

Override:

KintoClientBase#constructor

Test:

KintoClient #constructor