db/store

Documentation

• source: db/store.ts

Overview

Classes

Store

save()

Saves a new entry to the data store.

static save(name: string, entry: any): void;

Parameter	Type	Description
name	string	The entity/table name.
entry	any	The JavaScript object to save.

Returns

• Type: void
• Description: The ID of the newly created entry (string or number).

upsert()

Inserts a new entry or updates an existing one if the ID is present.

static upsert(name: string, entry: any): void;

Parameter	Type	Description
name	string	The entity/table name.
entry	any	The JavaScript object to insert/update.

Returns

• Type: void
• Description:

update()

Updates an existing entry.

static update(name: string, entry: any): void;

Parameter	Type	Description
name	string	The entity/table name.
entry	any	The JavaScript object with the ID and updated data.

Returns

• Type: void
• Description:

list()

Lists entries based on optional filtering, sorting, and pagination options.

static list(name: string, options: Options): void;

Parameter	Type	Description
name	string	The entity/table name.
options	Options	Optional Options for query execution.

Returns

• Type: void
• Description: An array of JavaScript objects.

count()

Counts the number of entries based on optional filtering options.

static count(name: string, options: Options): number;

Parameter	Type	Description
name	string	The entity/table name.
options	Options	Optional Options for query execution.

Returns

• Type: number
• Description: The count of matching entries.

get()

Retrieves a single entry by its ID.

static get(name: string, id: any): any;

Parameter	Type	Description
name	string	The entity/table name.
id	any	The ID of the entry.

Returns

• Type: any
• Description: The entry object, or undefined if not found.

remove()

Deletes an entry by its ID.

static remove(name: string, id: any): void;

Parameter	Type	Description
name	string	The entity/table name.
id	any	The ID of the entry to remove.

Returns

• Type: void
• Description:

find()

Finds entries matching an example object (query-by-example).

static find(name: string, example: any, limit: number, offset: number): void;

Parameter	Type	Description
name	string	The entity/table name.
example	any	An object containing properties to match.
limit	number	Maximum number of results to return.
offset	number	Number of results to skip.

Returns

• Type: void
• Description: An array of matching JavaScript objects.

query()

Queries all entries for a given script with pagination.

static query(query: string, parameters: any, limit: number, offset: number): void;

Parameter	Type	Description
query	string	The query script.
parameters	any
limit	number	Maximum number of results to return.
offset	number	Number of results to skip.

Returns

• Type: void
• Description: An array of JavaScript objects.

queryNative()

Queries all entries for a given entity name without pagination.

static queryNative(query: string, parameters: any, limit: number, offset: number): void;

Parameter	Type	Description
query	string	The entity/table name.
parameters	any
limit	number
offset	number

Returns

• Type: void
• Description: An array of all JavaScript objects.

getEntityName()

Gets the name of the entity associated with the store name.

static getEntityName(name: string): string;

Parameter	Type	Description
name	string

Returns

• Type: string
• Description:

getTableName()

Gets the underlying database table name for the entity.

static getTableName(name: string): string;

Parameter	Type	Description
name	string

Returns

• Type: string
• Description:

getIdName()

Gets the property name used as the ID field in the entity object.

static getIdName(name: string): string;

Parameter	Type	Description
name	string

Returns

• Type: string
• Description:

getIdColumn()

Gets the underlying database column name used for the ID field.

static getIdColumn(name: string): string;

Parameter	Type	Description
name	string

Returns

• Type: string
• Description: