The connected NEDB database instance
Convenience method to convert a document to something.
The function which will be called with a single document object. Guaranteed not to be null.
A transformFn
function to pass to the standard
select/delete/upsert/etc methods.
DELETE multiple documents.
Get Matrix users by some data about them, previously stored via the set method on the Matrix user.
The keys and matching values the remote users share.
This should use dot notation for nested types. For example:
{ "topLevel.midLevel.leaf": 42, "otherTopLevel": "foo" }
Resolves to a possibly empty list of MatrixUsers. Rejects with an error if there was a problem querying the store.
Retrieve a MatrixUser based on their user ID localpart. If there is more than one match (e.g. same localpart, different domains) then this will return an arbitrary matching user.
The user localpart
Resolves to a MatrixUser or null.
Get remote users by some data about them, previously stored via the set method on the Remote user.
The keys and matching values the remote users share.
This should use dot notation for nested types. For example:
{ "topLevel.midLevel.leaf": 42, "otherTopLevel": "foo" }
Resolves to a possibly empty list of RemoteUsers. Rejects with an error if there was a problem querying the store.
Retrieve a list of matrix user IDs linked to this remote ID.
The remote ID
A list of user IDs.
Get a matrix user by their user ID.
The user_id
Resolves to the user or null if they do not exist. Rejects with an error if there was a problem querying the store.
Retrieve a list of corresponding matrix users for the given remote ID.
The Remote ID
Resolves to a list of Matrix users.
Retrieve a list of remote IDs linked to this matrix user ID.
The matrix user ID
A list of remote IDs.
Get a remote user by their remote ID.
The remote ID
Resolves to the user or null if they do not exist. Rejects with an error if there was a problem querying the store.
Retrieve a list of corresponding remote users for the given matrix user ID.
The Matrix user ID
Resolves to a list of Remote users.
INSERT a multiple documents.
INSERT IF NOT EXISTS a single document
Create a link between a matrix and remote user. If either user does not exist, they will be inserted prior to linking. This is done to ensure foreign key constraints are satisfied (so you cannot have a mapping to a user ID which does not exist).
The matrix user
The remote user
SELECT a number of documents.
SELECT a single document.
Store a Matrix user. If they already exist, they will be updated. Equivalence is determined by their user ID.
The matrix user
Store a Remote user. If they already exist, they will be updated. Equivalence is determined by the Remote ID.
The remote user
Set a UNIQUE key constraint on the given field.
The field name. Use dot notation for nested objects.
Allow sparse entries (undefined won't cause a key violation).
Delete a link between a matrix user ID and a remote user ID.
The matrix user ID
The remote user ID
Resolves to the number of entries removed.
Delete a link between a matrix user and a remote user.
The matrix user
The remote user
Resolves to the number of entries removed.
UPDATE a single document. If the document already exists, this will NOT update it.
UPSERT a single document
Generated using TypeDoc
Construct a store suitable for user bridging information.