JSONStoreCollection

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async clearCollection(): Promise<string, JSON> source

Removes all documents from a collection, but does not destroy the collection.

Return:

Promise<string, JSON>

This function returns an empty string in case of success. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async countAllDirtyDocuments(): Promise<number, JSON> source

Count the number of dirty documents in the collection.

Return:

This function returns a number indicative of the count of all dirty documents. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async countAllDocuments(): Promise<number, JSON> source

Count the number of documents in the collection.

Return:

This function returns a number indicative of the count of all documents. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async countDocuments(query: Array<JSONStoreQueryPart>, includeDeleted: boolean): Promise<number, JSON> source

Count the number of documents in the collection that are based on the given query.

Params:

Name	Type	Attribute	Description
query	Array<JSONStoreQueryPart>		An array of JSONStoreQueryPart objects that limits the count scope. Every query part in the arrayare joined by an OR operation.
includeDeleted	boolean	optional	Additional options to modify the count operation.

Return:

This function returns a number indicative of the count of documents based on given query and whether to include deleted documents. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async findAllDirtyDocuments(): Promise<Array, JSON> source

Find all the dirty documents in the collection.

Return:

This function returns an array of documents that are found dirty in the collection. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async findAllDocuments(options: JSONStoreFindOptions): Promise<Array, JSON> source

Find all documents in the collection.

Params:

Name	Type	Attribute	Description
options	JSONStoreFindOptions	optional	The find query that restricts the search.

Return:

This function returns an array of documents that are found in the collection with the given Find Options. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async findDocumentById(id: number): Promise<object, JSON> source

Find a document in the collection based on the given ID.

Params:

Name	Type	Attribute	Description
id	number		The unique id that is associated with a document in the database (the _id search field).

Return:

Promise<object, JSON>

This function returns a document that is found for this given id. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async findDocuments(query: Array<JSONStoreQueryPart>, options: JSONStoreFindOptions): Promise<Array, JSON> source

Find documents in the collection that are based on the given query.

Params:

Name	Type	Attribute	Description
query	Array<JSONStoreQueryPart>		An array of JSONStoreQueryPart objects that limits the count scope. Every query part in the arrayare joined by an OR operation.
options	JSONStoreFindOptions	optional	Additional options to modify the count operation.

Return:

This function returns an array of all the documents that are found for this given query and find options. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async findDocumentsById(ids: Array): Promise<Array, JSON> source

Find all documents in the collection that have the given ids.

Params:

Name	Type	Attribute	Description
ids	Array		An array of unique ids that are associated with a document in the database (the _id search field).

Return:

This function returns an array of all the documents that are found for this given ids. In case of any error this function returns a JSON.

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async getAdditionalSearchFields(): Promise<object> source

Get a map of the additional search fields for this collection.

Return:

Promise<object>

This function returns an object of all the additional search fields for the given collection.

public async getSearchFields(): Promise<object> source

Get a map of all search fields for this collection.

Return:

Promise<object>

This function returns an object of all the search fields for the given collection.

public async hasAdditionalSearchField(searchField: string): Promise<boolean, JSON> source

Determines if the collection contains the given additional search field.

Params:

Name	Type	Attribute	Description
searchField	string		The name of the additional search field to check for existence.

Return:

This function returns a boolean value indicative of whether the collection contains the given additional search field or not, and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async hasSearchField(searchField: string): Promise<boolean, JSON> source

The name of the search field to check for existence.

Params:

Name	Type	Attribute	Description
searchField	string		The name of the additional search field to check for existence.

Return:

This function returns a boolean value indicative of whether the collection contains the given search field or not, and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async isDocumentDirty(id: number): Promise<boolean, JSON> source

Determine if a document is dirty or not.

Params:

Name	Type	Attribute	Description
id	number		ID of the document to be checked.

Return:

This function returns a boolean value indicative of whether the document is dirty or not, and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async markDocumentClean(document: JSON): Promise<number, JSON> source

Mark a document in the collection clean.

Params:

Name	Type	Attribute	Description
document	JSON		JSON document to be marked as clean.

Return:

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async markDocumentsClean(documents: Array): Promise<number, JSON> source

Mark an array of documents in the collection clean.

Params:

Name	Type	Attribute	Description
documents	Array		An Array of JSON documents to be marked as clean.

Return:

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async removeCollection(): Promise<string, JSON> source

Permanently deletes all the documents that are stored in a collection and destroys the collection.

Return:

Promise<string, JSON>

This function returns an empty string in case of success and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async removeDocumentById(id: number, markDirty: boolean): Promise<number, JSON> source

Remove a document from the collection that is based on the given id.

Params:

Name	Type	Attribute	Description
id	number		ID of the document to be deleted.
markDirty	boolean	optional	Mark the document as dirty. Default is false.

Return:

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async removeDocumentsById(ids: number, markDirty: boolean): Promise<number, JSON> source

Remove array of documents from the collection, based on the given ids.

Params:

Name	Type	Attribute	Description
ids	number		ID of the document to be deleted.
markDirty	boolean	optional	Mark the document as dirty using this flag. Default is false.

Return:

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async replaceDocument(document: JSON, markDirty: boolean): Promise<number, JSON> source

Replace a document in the collection.

Params:

Name	Type	Attribute	Description
document	JSON		A JSONObject that represents the document to update in the collection. The document's '_id' is used to determine which document to replace.
markDirty	boolean	optional	Mark the document as dirty using this flag. Default is false.

Return:

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public async replaceDocuments(documents: Array, markDirty: boolean): Promise<number, JSON> source

Replace an array of documents in the collection.

Params:

Name	Type	Attribute	Description
documents	Array		A List that contains JSONObjects that represent the documents to update in the collection. The document's '_id' is used to determine which document to replace. If all documents could not be updated, a rollback is performed to a state where no documents were updated.
markDirty	boolean	optional	Mark the document as dirty using this flag. Default is false.

Return:

This function returns a number indicative of number of documents affected and it returns a JSON in case of any error

Example:

- If the promise is rejected, an error JSON in the following format is available with more information.
{
     errorMsg: "Error adding data to collection: favourites", 
     reason: "Collection is not initialized."
}

public setAdditionalSearchField(key: string, searchFieldType: string): * source

Set an additional search field for the collection.

Params:

Name	Type	Attribute	Description
key	string		The name of the additional search field to add. Only useful before the collection is opened.
searchFieldType	string		The type of the search field. Accepted values are ('boolean', 'integer', 'number', 'string')

Return:

public setSearchField(key: string, searchFieldType: string): * source

Set a search field for the collection.

Params:

Name	Type	Attribute	Description
key	string		The name of the additional search field to add. Only useful before the collection is opened.
searchFieldType	string		The type of the search field. Accepted values are ('boolean', 'integer', 'number', 'string')

Return:

public sync() source

Sync this collection based on Sync policy set when the collection was opened.

public async wasReopened(): Promise<boolean, JSON> source

Determine if the collection was reopened when it was initialized.

Return: