Home Reference Source Test

References

summary
public

High level HTTP client for the Kinto API.

public

C Bucket

Abstract representation of a selected bucket.

public

Abstract representation of a selected collection.

public
public

"Error" subclass representing a >=400 response from the server.

public
private

C HTTP

Enhanced HTTP client for the Kinto protocol.

public
private

F aggregate(responses: Array, requests: Array): Object

Exports batch responses as a result object.

private

F endpoint(name: String, args: ...string): String

Retrieves a server enpoint by its name.

private

F addAttachmentRequest(path: *, dataURI: *, objectPattern2: {"data": *, "permissions": *}, options: {}): {"method": string, "path": *, "headers": *, "body": *}

private

F createRequest(path: *, objectPattern1: {"data": *, "permissions": *}, options: {}): {"method": *, "path": *, "headers": *, "body": *}

private

F deleteRequest(path: *, options: {}): {"method": string, "path": *, "headers": *}

private

F jsonPatchPermissionsRequest(path: *, permissions: *, opType: *, options: {}): {"method": string, "path": *, "headers": *, "body": *}

private

F safeHeader(safe: *, last_modified: *): {"If-None-Match": string}

private

F updateRequest(path: *, objectPattern1: {"data": *, "permissions": *}, options: {}): {"method": *, "path": *, "headers": *, "body": *}

public

F capable(capabilities: Array<String>): Function

Generates a decorator function ensuring that the specified capabilities are available on the server before executing it.

public

F checkVersion(version: String, minVersion: String, maxVersion: String)

Checks if a version is within the provided range.

private

Clones an object with all its undefined keys removed.

public

F createFormData(dataURL: String, body: Object, options: Object): FormData

Creates a FormData instance from a data url and an existing JSON response body.

public

F delay(ms: *): *

Returns a Promise always resolving after the specified amount in milliseconds.

public

F extractFileInfo(dataURL: String): Object

Extracts file information from a data url.

public

F isObject(thing: Object): bool

Returns true if the specified value is an object (i.e.

public

F nobatch(message: String): Function

Generates a decorator function ensuring an operation is not performed from within a batch request.

private

F omit(obj: Object, keys: ...String): Object

Takes an object and returns a copy of it with the provided keys omitted.

private

F async pMap(list: Array, fn: Function): Promise

Maps a list to promises using the provided mapping function, executes them sequentially then returns a Promise resolving with ordered results obtained.

public

F parseDataURL(dataURL: String): Object

Parses a data url.

private

F partition(array: Array, n: Number): Array

Chunks an array into n pieces.

public

F qsify(obj: Object): String

Transforms an object into an URL query string, stripping out any undefined values.

public

F support(min: String, max: String): Function

Generates a decorator function ensuring a version check is performed against the provided requirements before executing it.

private

F toDataBody(resource: Object | String): Object

Always returns a resource data object from the provided argument.

public

Currently supported protocol version.

public

V ENDPOINTS: Object

Endpoints templates.

public

V ERROR_CODES: Object

Kinto server error code descriptors.

public

V requestDefaults: {"safe": *, "headers": *, "permissions": *, "data": *, "patch": *}