Class EventBridgeStore

Construct a store suitable for event mapping information. Data is stored as StoredEvents.

Param

The connected NEDB database instance

Hierarchy

BridgeStore
- EventBridgeStore

Index

Constructors

constructor

Properties

Methods

convertTo delete getEntryByMatrixId getEntryByRemoteId insert insertIfNotExists removeEvent removeEventByMatrixId removeEventByRemoteId select selectOne setUnique update upsert upsertEvent

Constructors

constructor

new EventBridgeStore(db: Nedb<any>): EventBridgeStore
Parameters
- db: Nedb<any>
Returns EventBridgeStore

Overrides BridgeStore.constructor

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
Inherited from BridgeStore.convertTo

delete

delete(query: Query): Promise<number>
DELETE multiple documents.
Parameters
- query: Query
Returns Promise<number>

Inherited from BridgeStore.delete

getEntryByMatrixId

getEntryByMatrixId(roomId: string, eventId: string): Promise<null | StoredEvent>
Get an existing event based on the provided matrix IDs.

Returns
A promise which resolves to the StoredEvent or null.
Parameters
- roomId: string
  
  The ID of the room.
- eventId: string
  
  The ID of the event.
Returns Promise<null | StoredEvent>

getEntryByRemoteId

getEntryByRemoteId(roomId: string, eventId: string): Promise<null | StoredEvent>
Get an existing event based on the provided remote IDs.

Returns
A promise which resolves to the StoredEvent or null.
Parameters
- roomId: string
  
  The ID of the room.
- eventId: string
  
  The ID of the event.
Returns Promise<null | StoredEvent>

insert

insert(objects: unknown): Promise<any[]>
INSERT a multiple documents.
Parameters
- objects: unknown
Returns Promise<any[]>

Inherited from BridgeStore.insert

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>

Inherited from BridgeStore.insertIfNotExists

removeEvent

removeEvent(event: StoredEvent): Promise<number>
Remove entries based on the event data.
Parameters
- event: StoredEvent
  
  The event to remove.
Returns Promise<number>

removeEventByMatrixId

removeEventByMatrixId(roomId: string, eventId: string): Promise<number>
Remove entries based on the matrix IDs.
Parameters
- roomId: string
  
  The ID of the room.
- eventId: string
  
  The ID of the event.
Returns Promise<number>

removeEventByRemoteId

removeEventByRemoteId(roomId: string, eventId: string): Promise<number>
Remove entries based on the matrix IDs.
Parameters
- roomId: string
  
  The ID of the room.
- eventId: string
  
  The ID of the event.
Returns Promise<number>

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[]>

Inherited from BridgeStore.select

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>

Inherited from BridgeStore.selectOne

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

Inherited from BridgeStore.setUnique

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>

Inherited from BridgeStore.update

upsert

upsert<T>(query: Query, updateVals: T): Promise<void>
UPSERT a single document
Type Parameters
- T
Parameters
- query: Query
- updateVals: T
Returns Promise<void>

Inherited from BridgeStore.upsert

upsertEvent

upsertEvent(event: StoredEvent): Promise<void>
Insert an event, clobbering based on the ID of the StoredEvent.
Parameters
- event: StoredEvent
Returns Promise<void>

Class EventBridgeStore

Param

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Nedb<any>

Returns EventBridgeStore

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>

getEntryByMatrixId

Returns

Parameters

roomId: string

eventId: string

Returns Promise<null | StoredEvent>

getEntryByRemoteId

Returns

Parameters

roomId: string

eventId: string

Returns Promise<null | StoredEvent>

insert

Parameters

objects: unknown

Returns Promise<any[]>

insertIfNotExists

Parameters

query: Query

insertObj: Record<string, unknown>

Returns Promise<void>

removeEvent

Parameters

event: StoredEvent

Returns Promise<number>

removeEventByMatrixId

Parameters

roomId: string

eventId: string

Returns Promise<number>

removeEventByRemoteId

Parameters

roomId: string

eventId: string

Returns Promise<number>

select

Type Parameters

T

O

Parameters

query: Query

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

Parameters

input: T

Returns O

Returns Promise<O[]>

selectOne

`Readonly` db

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

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