Home Reference Source Test

References

summary
public

KintoBase class.

public

Abstracts a collection of records stored in the local database, providing CRUD operations and synchronization helpers.

public

A Collection-oriented wrapper for an adapter's transaction.

This defines the high-level functions available on a collection. The collection itself offers functions of the same name. These will perform just one operation in its own transaction.

public
public

Synchronization result object.

public

C Kinto

public

IDSchema for when using kinto.js as a key-value store.

public
public

F importChange(transaction: IDBTransactionProxy, remote: Object, localFields: Array<String>): Object

Import a remote change into the local database.

public

F markDeleted(record: *): *

public

F markStatus(record: *, status: *): {...record: Object, "_status": *}

public

F markSynced(record: *): *

public

F recordsEqual(a: Object, b: Object, localFields: Array): boolean

Compare two records omitting local fields and synchronization attributes (like _status and last_modified)

private

F _isUndefined(value: Any): Boolean

Checks if a value is undefined.

public

F arrayEqual(a: *, b: *): boolean

public

F deepEqual(a: Object, b: Object): Boolean

Simple deep object comparison function.

public

F filterObject(filters: Object, entry: Object): Boolean

Test if a single object matches all given filters.

public

F filterObjects(filters: Object, list: Array): Array

Filters records in a list matching all given filters.

public

F makeNestedObjectFromArr(arr: *, val: *, nestedFiltersObj: *): *

public

F omitKeys(obj: Object, keys: Array): Object

Return an object without the specified keys.

public

F sortObjects(order: String, list: Array): Array

Sorts records in a list according to a given ordering.

public

F transformSubObjectFilters(filtersObj: *): *

public

F waterfall(fns: Array, init: Any): Promise

Resolves a list of functions sequentially, which can be sync or async; in case of async, functions must return a promise.

public
public

V DEFAULT_REMOTE: string

public

V DEFAULT_RETRY: number

public

V AVAILABLE_HOOKS: string[]

public
public

V RE_RECORD_ID: undefined

adapters

summary
public

C IDB

IndexedDB adapter.

public abstract

Base db adapter.

public

F createListRequest(cid: String, store: IDBStore, filters: Object, done: Function): IDBRequest

Creates an IDB request and attach it the appropriate cursor event handler to perform a list query.

public

F async deleteDatabase(dbName: *): Promise

Helper to wrap the deletion of an IndexedDB database into a promise.

public

F async execute(db: *, name: *, callback: *, options: *): Promise

Helper to run the specified callback in a single transaction on the specified store.

public

F async migrationRequired(dbName: *): *

Up to version 10.X of kinto.js, each collection had its own collection.

public

F async open(dbname: *, version: *, onupgradeneeded: *): Promise<IDBDatabase>

Small helper that wraps the opening of an IndexedDB into a Promise.

public

F transactionProxy(adapter: IDB, store: IDBStore, preloaded: Array): Object

IDB transaction proxy.

public

V INDEXED_FIELDS: string[]

public

V cursorHandlers: Object

IDB cursor handlers.

Directories