Interface default

Hierarchy

  • default

Implemented by

Properties

create deleteEntry deleteGroup read search update

Properties

create

create: ((entityName, keyName, data) => Promise<object>)

Type declaration

    • (entityName, keyName, data): Promise<object>

    • Create a new object in a database at entity[key].

      Parameters

      • entityName: string

        The name of the entity to create the object in.

      • keyName: string

        The name of the key that the object will be stored under.

      • data: object

        The data to store.

      Returns Promise<object>

      True if the data was successfully created, false otherwise.

deleteEntry

deleteEntry: ((entityName, keyName, fieldName) => Promise<boolean>)

Type declaration

    • (entityName, keyName, fieldName): Promise<boolean>

    • Delete a single row or field from a database at entity[key].

      Parameters

      • entityName: string

        The name of the entity to delete the object from.

      • keyName: string

        The name of the key that the object is stored under.

      • fieldName: string

        The name of the key that the object is stored under.

      Returns Promise<boolean>

      True if the data was successfully deleted, false otherwise.

deleteGroup

deleteGroup: ((entityName, keyName) => Promise<boolean>)

Type declaration

    • (entityName, keyName): Promise<boolean>

    • Delete an entire group under entity[key].

      Parameters

      • entityName: string

        The name of the entity to delete.

      • keyName: string

        The name of the key that the object is stored under.

      Returns Promise<boolean>

      True if the data was successfully deleted, false otherwise.

read

read: ((entityName, keyName) => Promise<any>)

Type declaration

    • (entityName, keyName): Promise<any>

    • Read an object from a database at entity[key].

      Parameters

      • entityName: string

        The name of the entity to read the object from.

      • keyName: string

        The name of the key that the object is stored under.

      Returns Promise<any>

      The data stored at entity[key].

search

search: ((entityName, keyName, needle, comparison, caseSensitive) => Promise<boolean | object[]>)

Type declaration

    • (entityName, keyName, needle, comparison, caseSensitive): Promise<boolean | object[]>

    • Search for an object in a database at entity[key] that matches the given criteria.

      Throws

      If the comparison is invalid.

      Parameters

      • entityName: string

        The name of the entity to search the object in.

      • keyName: string

        The name of the key that the object is stored under.

      • needle: string

        The value to search for.

      • comparison: string

        The comparison to use when searching.

      • caseSensitive: boolean

        Whether or not the search should be case sensitive.

      Returns Promise<boolean | object[]>

      True if the object was found, false otherwise.

update

update: ((entityName, keyName, data) => Promise<boolean>)

Type declaration

    • (entityName, keyName, data): Promise<boolean>

    • Update an object in a database at entity[key].

      Parameters

      • entityName: string

        The name of the entity to update the object in.

      • keyName: string

        The name of the key that the object is stored under.

      • data: object

        The data to store.

      Returns Promise<boolean>

      True if the data was successfully updated, false otherwise.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc