Class EventBridgeStore

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

Param: db

The connected NEDB database instance

Hierarchy (view full)

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): EventBridgeStore
Parameters
- db: Nedb<any>
Returns EventBridgeStore
Overrides BridgeStore.constructor
- Defined in src/components/event-bridge-store.ts:28

Properties

`Readonly` db

db: Nedb<any>

Methods

convertTo

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

delete

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

getEntryByMatrixId

getEntryByMatrixId(roomId, eventId): Promise<null | StoredEvent>
Get an existing event based on the provided matrix IDs.
Parameters
- roomId: string
  The ID of the room.
- eventId: string
  The ID of the event.
Returns Promise<null | StoredEvent>
A promise which resolves to the StoredEvent or null.
- Defined in src/components/event-bridge-store.ts:46

getEntryByRemoteId

getEntryByRemoteId(roomId, eventId): Promise<null | StoredEvent>
Get an existing event based on the provided remote IDs.
Parameters
- roomId: string
  The ID of the room.
- eventId: string
  The ID of the event.
Returns Promise<null | StoredEvent>
A promise which resolves to the StoredEvent or null.
- Defined in src/components/event-bridge-store.ts:61

insert

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

insertIfNotExists

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

removeEvent

removeEvent(event): Promise<number>
Remove entries based on the event data.
Parameters
- event: StoredEvent
  The event to remove.
Returns Promise<number>
- Defined in src/components/event-bridge-store.ts:74

removeEventByMatrixId

removeEventByMatrixId(roomId, eventId): 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>
- Defined in src/components/event-bridge-store.ts:85

removeEventByRemoteId

removeEventByRemoteId(roomId, eventId): 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>
- Defined in src/components/event-bridge-store.ts:97

select

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

selectOne

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

setUnique

setUnique(fieldName, sparse?): 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
- Defined in src/components/bridge-store.ts:119

update

update(query, updateVals): 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
- Defined in src/components/bridge-store.ts:68

upsert

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

upsertEvent

upsertEvent(event): Promise<void>
Insert an event, clobbering based on the ID of the StoredEvent.
Parameters
- event: StoredEvent
Returns Promise<void>
- Defined in src/components/event-bridge-store.ts:34

Class EventBridgeStore

Param: db

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: Nedb<any>

Returns EventBridgeStore

Properties

Readonly db

Methods

convertTo

Type Parameters

T

O

Parameters

func: ((input) => O)

Parameters

input: T

Returns O

Returns ((doc) => O)

Parameters

doc: T

Returns O

delete

Parameters

query: Query

Returns Promise<number>

getEntryByMatrixId

Parameters

roomId: string

eventId: string

Returns Promise<null | StoredEvent>

getEntryByRemoteId

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) => O)

Parameters

input: T

Returns O

Returns Promise<O[]>

selectOne

Type Parameters

T

O

`Readonly` db

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

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