Class BridgeStore

Base class for bridge stores.

Hierarchy

BridgeStore

Index

Constructors

constructor

Properties

Methods

convertTo delete insert insertIfNotExists select selectOne setUnique update upsert

Constructors

constructor

new BridgeStore(db: Nedb<any>): BridgeStore
Parameters
- db: Nedb<any>
Returns BridgeStore
- Defined in src/components/bridge-store.ts:31

Properties

`Readonly` db

db: Nedb<any>

Methods

convertTo

convertTo<T, O>(func: ((input: T) => O)): ((doc: T) => O)
Convenience method to convert a document to something.

Returns
A transformFn function to pass to the standard select/delete/upsert/etc methods.
Type Parameters
- T
- O
Parameters
- func: ((input: T) => O)
  
  The function which will be called with a single document object. Guaranteed not to be null.
  - - (input: T): O
    - Parameters
      
      input: T
      
      Returns O
Returns ((doc: T) => O)
- - (doc: T): O
  - Parameters
    - doc: T
    Returns O
- Defined in src/components/bridge-store.ts:133

delete

delete(query: Query): Promise<number>
DELETE multiple documents.
Parameters
- query: Query
Returns Promise<number>
- Defined in src/components/bridge-store.ts:74

insert

insert(objects: unknown): Promise<any[]>
INSERT a multiple documents.
Parameters
- objects: unknown
Returns Promise<any[]>
- Defined in src/components/bridge-store.ts:42

insertIfNotExists

insertIfNotExists(query: Query, insertObj: Record<string, unknown>): Promise<void>
INSERT IF NOT EXISTS a single document
Parameters
- query: Query
- insertObj: Record<string, unknown>
Returns Promise<void>
- Defined in src/components/bridge-store.ts:56

select

select<T, O>(query: Query, transformFn?: ((input: T) => O)): Promise<O[]>
SELECT a number of documents.
Type Parameters
- T
- O
Parameters
- query: Query
- Optional transformFn: ((input: T) => O)
  - - (input: T): O
    - Parameters
      
      input: T
      
      Returns O
Returns Promise<O[]>
- Defined in src/components/bridge-store.ts:98

selectOne

selectOne<T, O>(query: Query, transformFn?: ((input: T) => O)): Promise<null | O>
SELECT a single document.
Type Parameters
- T
- O
Parameters
- query: Query
- Optional transformFn: ((input: T) => O)
  - - (input: T): O
    - Parameters
      
      input: T
      
      Returns O
Returns Promise<null | O>
- Defined in src/components/bridge-store.ts:81

setUnique

setUnique(fieldName: string, sparse?: boolean): void
Set a UNIQUE key constraint on the given field.
Parameters
- fieldName: string
  
  The field name. Use dot notation for nested objects.
- sparse: boolean = false
  
  Allow sparse entries (undefined won't cause a key violation).
Returns void
- Defined in src/components/bridge-store.ts:118

update

update(query: Query, updateVals: Record<string, unknown>): Promise<void>
UPDATE a single document. If the document already exists, this will NOT update it.
Parameters
- query: Query
- updateVals: Record<string, unknown>
Returns Promise<void>
- Defined in src/components/bridge-store.ts:67

upsert

upsert<T>(query: Query, updateVals: T): Promise<void>
UPSERT a single document
Type Parameters
- T
Parameters
- query: Query
- updateVals: T
Returns Promise<void>
- Defined in src/components/bridge-store.ts:49

Class BridgeStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Nedb<any>

Returns BridgeStore

Properties

Readonly db

Methods

convertTo

Returns

Type Parameters

T

O

Parameters

func: ((input: T) => O)

Parameters

input: T

Returns O

Returns ((doc: T) => O)

Parameters

doc: T

Returns O

delete

Parameters

query: Query

Returns Promise<number>

insert

Parameters

objects: unknown

Returns Promise<any[]>

insertIfNotExists

Parameters

query: Query

insertObj: Record<string, unknown>

Returns Promise<void>

select

Type Parameters

T

O

Parameters

query: Query

Optional transformFn: ((input: T) => O)

Parameters

input: T

Returns O

Returns Promise<O[]>

selectOne

Type Parameters

T

O

Parameters

query: Query

Optional transformFn: ((input: T) => O)

Parameters

input: T

Returns O

Returns Promise<null | O>

setUnique

Parameters

fieldName: string

sparse: boolean = false

Returns void

update

Parameters

query: Query

updateVals: Record<string, unknown>

Returns Promise<void>

upsert

Type Parameters

T

Parameters

query: Query

updateVals: T

Returns Promise<void>

`Readonly` db

`Optional` transformFn: ((input: T) => O)

`Optional` transformFn: ((input: T) => O)