import Collection from 'kinto-client/lib/collection.js'

public class | source

Collection

Abstract representation of a selected collection.

Test:

Collection

Constructor Summary

Public Constructor
public	constructor(client: KintoClient, bucket: Bucket, name: String) Constructor.

Member Summary

Public Members
public	name: String The collection name.

Method Summary

Public Methods
public	batch(fn: Function, options: Object): Promise<Object, Error> Performs batch operations at the current collection level.
public	createRecord(record: Object, options: Object): Promise<Object, Error> Creates a record in current collection.
public	deleteRecord(record: Object \| String, options: Object): Promise<Object, Error> Deletes a record from the current collection.
public	getData(options: Object): Promise<Object, Error> Retrieves collection data.
public	getPermissions(options: Object): Promise<Object, Error> Retrieves the list of permissions for this collection.
public	getRecord(id: String, options: Object): Promise<Object, Error> Retrieves a record from the current collection.
public	listRecords(options: Object): Promise<Object, Error> Lists records from the current collection.
public	setData(data: Object, options: Object): Promise<Object, Error> Set collection data.
public	setPermissions(permissions: Object, options: Object): Promise<Object, Error> Replaces all existing collection permissions with the ones provided.
public	updateRecord(record: Object, options: Object): Promise<Object, Error> Updates a record in current collection.

Public Constructors

public constructor(client: KintoClient, bucket: Bucket, name: String) source

Constructor.

Params:

Name	Type	Attribute	Description
client	KintoClient		The client instance.
bucket	Bucket		The bucket instance.
name	String		The collection name.
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.

Public Members

public name: String source

The collection name.

Public Methods

public batch(fn: Function, options: Object): Promise<Object, Error> source

Performs batch operations at the current collection level.

Params:

Name	Type	Attribute	Description
fn	Function		The batch operation function.
options	Object		The options object.
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.
options.aggregate	Boolean		Produces a grouped result object.

Return:

Promise<Object, Error>

Test:

Collection #batch()

public createRecord(record: Object, options: Object): Promise<Object, Error> source

Creates a record in current collection.

Params:

Name	Type	Attribute	Description
record	Object		The record to create.
options	Object		The options object.
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.

Return:

Promise<Object, Error>

Test:

Collection #createRecord()

public deleteRecord(record: Object | String, options: Object): Promise<Object, Error> source

Deletes a record from the current collection.

Params:

Name	Type	Attribute	Description
record	Object \| String		The record to delete.
options	Object		The options object.
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.
options.last_modified	Number		The last_modified option.

Return:

Promise<Object, Error>

Test:

Collection #deleteRecord()

public getData(options: Object): Promise<Object, Error> source

Retrieves collection data.

Params:

Name	Type	Attribute	Description
options	Object		The options object.
options.headers	Object		The headers object option.

Return:

Promise<Object, Error>

Test:

public getPermissions(options: Object): Promise<Object, Error> source

Retrieves the list of permissions for this collection.

Params:

Name	Type	Attribute	Description
options	Object		The options object.
options.headers	Object		The headers object option.

Return:

Promise<Object, Error>

Test:

Collection #getPermissions()

public getRecord(id: String, options: Object): Promise<Object, Error> source

Retrieves a record from the current collection.

Params:

Name	Type	Attribute	Description
id	String		The record id to retrieve.
options	Object		The options object.
options.headers	Object		The headers object option.

Return:

Promise<Object, Error>

Test:

Collection #getRecord()

public listRecords(options: Object): Promise<Object, Error> source

Lists records from the current collection.

Sorting is done by passing a sort string option:

The field to order the results by, prefixed with - for descending. Default: -last_modified.

Params:

Name	Type	Attribute	Description
options	Object		The options object.
options.headers	Object		The headers object option.
options.filters	Object		The filters object.
options.sort	String		The sort field.
options.limit	String		The limit field.
options.pages	String		The number of result pages to aggregate.
options.since	Number		Only retrieve records modified since the provided timestamp.

Return:

Promise<Object, Error>

Test:

Collection #listRecords()

See:

public setData(data: Object, options: Object): Promise<Object, Error> source

Set collection data.

Params:

Name	Type	Attribute	Description
data	Object		The collection data object.
options	Object		The options object.
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.
options.patch	Boolean		The patch option.

Return:

Promise<Object, Error>

public setPermissions(permissions: Object, options: Object): Promise<Object, Error> source

Replaces all existing collection permissions with the ones provided.

Params:

Name	Type	Attribute	Description
permissions	Object		The permissions object.
options	Object		The options object
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.
options.last_modified	Number		The last_modified option.

Return:

Promise<Object, Error>

Test:

Collection #setPermissions()

public updateRecord(record: Object, options: Object): Promise<Object, Error> source

Updates a record in current collection.

Params:

Name	Type	Attribute	Description
record	Object		The record to update.
options	Object		The options object.
options.headers	Object		The headers object option.
options.safe	Boolean		The safe option.
options.last_modified	Number		The last_modified option.

Return:

Promise<Object, Error>

Test:

Collection #updateRecord()