Class NedbClient

constructor

• new NedbClient(dbName, dbDirectoryPath, collectionsList): NedbClient

• Creates an instance of NedbClient.

  Parameters

  • dbName: string

    A unique name for the database.
  • dbDirectoryPath: string

    The folder path for where the database and its collections will be stored.
  • collectionsList: CollectionListEntry[]

    An array of collections, where each item in this array is an object containing the name of the collection and the model or document that the collection will use.

  Returns NedbClient

  Author

  BigfootDS

collections

documents

embeddedDocuments

name

path

count

• count(collectionName, query): Promise<number>

• Query a collection and receive a number representing the count of documents matching that query.

  Parameters

  • collectionName: string

    The name of the collection that you wish search through.
  • query: object

    The NeDB query used to find the specific document within the collection.

  Returns Promise<number>

  Integer number of documents within the specified collection that match the query.

  Author

  BigfootDS

createCollection

• createCollection(model, name): CollectionAccessor

• Add a new collection to an existing database.

  Parameters

  • model: typeof NedbDocument
  • name: string

  Returns CollectionAccessor

  Author

  BigfootDS

createIndex

• createIndex(collectionName, indexOptions): Promise<void>

• Configure an enforced constraint on a collection.

  See the @seald/nedb documentation for more info about NeDB indexes.

  Parameters

  • collectionName: string

    A string of the collection name to target within the database.
  • indexOptions: EnsureIndexOptions

    An object per the @seald/nedb documentation to configure the index that is to be created.

  Returns Promise<void>

  Promise.

  Author

  BigfootDS

createMany

• createMany(collectionName, dataObjectArray): Promise<NedbDocument[]>

• Create multiple document instances from a provided array of object data, insert each document instance into the database, and return the array of document instances.

  Parameters

  • collectionName: string
  • dataObjectArray: object[]

  Returns Promise<NedbDocument[]>

  Author

  BigfootDS

createOne

• createOne(collectionName, dataObject): Promise<NedbDocument>

• Create a document instance from a provided object of data, insert the new document instance into the database, and return the new document instance.

  Parameters

  • collectionName: string
  • dataObject: object

  Returns Promise<NedbDocument>

  Author

  BigfootDS

deleteCollectionByModel

• deleteCollectionByModel(model, deleteData?): Promise<number>

• Delete collections by model. Can delete multiple collections that use the same model.

  You can also specify whether or not the data within the collection should be deleted, just as a sanity-check. This is enabled by default.

  Parameters

  • model: typeof NedbDocument

    The model to search for.
  • OptionaldeleteData: boolean = true

    Whether or not data within the collection should be deleted. Defaults to true.

  Returns Promise<number>

  The number of collections with a matching name that were deleted.

  Author

  BigfootDS

deleteCollectionByName

• deleteCollectionByName(name, deleteData?): Promise<number>

• Delete collections by name. Can delete multiple collections that use the same name.

  You can also specify whether or not the data within the collection should be deleted, just as a sanity-check. This is enabled by default.

  Parameters

  • name: string

    The name of the collections to search for.
  • OptionaldeleteData: boolean = true

    Whether or not data within the collection should be deleted. Defaults to true.

  Returns Promise<number>

  The number of collections with a matching name that were deleted.

  Author

  BigfootDS

dropDatabase

• dropDatabase(): Promise<void>

• Delete all documents in all collections within this database. Highly destructive. Could use more work.

  Returns Promise<void>

  Author

  BigfootDS

findAndDeleteMany

• findAndDeleteMany(collectionName, query, options?): Promise<number>

• Find and delete multiple documents from a specified collection.

  Parameters

  • collectionName: string

    The name of the collection that you wish to search through and modify.
  • query: object

    The NeDB query used to find the specific documents within the collection.
  • options: RemoveOptions = ...

    Options to pass to the query system in NeDB. For this particular method, multi is always set to true.

  Returns Promise<number>

  Number of removed documents.

  Author

  BigfootDS

findAndDeleteOne

• findAndDeleteOne(collectionName, query, options?): Promise<number>

• Find and delete one document from a specified collection.

  Parameters

  • collectionName: string

    The name of the collection that you wish to search through and modify.
  • query: object

    The NeDB query used to find the specific document within the collection.
  • options: RemoveOptions = ...

    Options to pass to the query system in NeDB. For this particular method, multi is always set to false.

  Returns Promise<number>

  Number of removed documents.

  Author

  BigfootDS

findAndUpdateManyDocuments

• findAndUpdateManyDocuments(collectionName, query, newData, options?): Promise<NedbDocument[]>

• Search a database for one or more matched documents and modify them, returning the modified documents as an array of document instances.

  If no documents match the given query, this function will return an empty array.

  Parameters

  • collectionName: string

    The name of the database collection to query.
  • query: object

    The query to run to find the relevant document.
  • newData: object

    The data to apply to the found document.
  • Optionaloptions: updateManyOptions

    Optional. The options that can be used in this operation.

  Returns Promise<NedbDocument[]>

  Author

  BigfootDS

findAndUpdateManyObjects

• findAndUpdateManyObjects(collectionName, query, newData, options?): Promise<object[]>

• Search a database for one or more matched documents and modify them, returning the modified documents as an array of plain objects.

  If no documents match the given query, this function will return an empty array.

  Parameters

  • collectionName: string

    The name of the database collection to query.
  • query: object

    The query to run to find the relevant document.
  • newData: object

    The data to apply to the found document.
  • Optionaloptions: updateManyOptions

    Optional. The options that can be used in this operation.

  Returns Promise<object[]>

  Author

  BigfootDS

findAndUpdateOneDocument

• findAndUpdateOneDocument(collectionName, query, newData, options?): Promise<null | NedbDocument>

• Search a database for a singular matched document and modify it, returning the modified document as a document instance.

  Parameters

  • collectionName: string

    The name of the database collection to query.
  • query: object

    The query to run to find the relevant document.
  • newData: object

    The data to apply to the found document.
  • Optionaloptions: updateOptions

    Optional. The options that can be used in this operation.

  Returns Promise<null | NedbDocument>

  Author

  BigfootDS

findAndUpdateOneObject

• findAndUpdateOneObject(collectionName, query, newData, options?): Promise<null | object>

• Search a database for a singular matched document and modify it, returning the modified document as a plain object.

  Parameters

  • collectionName: string

    The name of the database collection to query.
  • query: object

    The query to run to find the relevant document.
  • newData: object

    The data to apply to the found document.
  • Optionaloptions: updateOptions

    Optional. The options that can be used in this operation.

  Returns Promise<null | object>

  Author

  BigfootDS

findManyDocuments

• findManyDocuments(collectionName, query, options?): Promise<NedbDocument[]>

• Query a collection and return an array of document instances matching that query.

  This method is NOT compatible with NeDB projections.

  Even if nothing matches the given query, an array is returned.

  Parameters

  • collectionName: string

    The name of the collection that you wish to search through.
  • query: object

    The NeDB query used to find the specific document within the collection. Read more about NeDB queries here: https://github.com/seald/nedb?tab=readme-ov-file#finding-documents
  • Optionaloptions: findManyDocumentsOptions

    Optional. Configuration for this database operation.

  Returns Promise<NedbDocument[]>

  An instance of the collection's model.

  Author

  BigfootDS

findManyObjects

• findManyObjects(collectionName, query, options?): Promise<object[]>

• Query a collection and return an array of objects matching that query, where each object is a document's data.

  This method is compatible with NeDB projections, allowing you to trim the returned data. Read more in the NeDB documentation.

  Even if nothing matches the given query, an array is returned.

  Parameters

  • collectionName: string

    The name of the collection that you wish to search through.
  • query: object

    The NeDB query used to find the specific document within the collection. Read more about NeDB queries here: https://github.com/seald/nedb?tab=readme-ov-file#finding-documents
  • Optionaloptions: findManyObjectsOptions

    Optional. Configuration for this database operation.

  Returns Promise<object[]>

  An instance of the collection's model.

  Author

  BigfootDS

findOneDocument

• findOneDocument(collectionName, query): Promise<null | NedbDocument>

• Query a collection and receive the first document matching that query, returned as a document instance.

  This method is NOT compatible with NeDB projections, and thus returns an instance of the document used by the specified collection.

  Parameters

  • collectionName: string

    The name of the collection that you wish to search through.
  • query: object

    The NeDB query used to find the specific document within the collection. Read more about NeDB queries here: https://github.com/seald/nedb?tab=readme-ov-file#finding-documents

  Returns Promise<null | NedbDocument>

  An instance of the collection's model.

  Author

  BigfootDS

findOneObject

• findOneObject(collectionName, query, options?): Promise<null | object>

• Query a collection and receive the first document matching that query, returned as a plain object.

  This method is compatible with NeDB projections, allowing you to trim the returned data. Read more in the NeDB documentation.

  Parameters

  • collectionName: string

    The name of the collection that you wish to search through.
  • query: object

    The NeDB query used to find the specific document within the collection. Read more about NeDB queries here: https://github.com/seald/nedb?tab=readme-ov-file#finding-documents
  • Optionaloptions: findOneObjectOptions

    Optional. Configuration for this database operation.

  Returns Promise<null | object>

  An instance of the collection's model.

  Author

  BigfootDS

getCollectionAccessor

• getCollectionAccessor(collectionName): CollectionAccessor

• Retrieve the collection meta object stored on the NeDB client instance matching a given collection name.

  Parameters

  • collectionName: string

    A string of the collection name to target within the database.

  Returns CollectionAccessor

  An object containing helper properties to perform collection-related operations.

  Author

  BigfootDS

insertMany

• insertMany(collectionName, dataObjectArray): Promise<object[]>

• Insert an array of objects of data into the database, following a document schema, and return the saved array of objects of data.

  Parameters

  • collectionName: string

    The name of the collection to insert the data into.
  • dataObjectArray: object[]

    The data to be inserted.

  Returns Promise<object[]>

  The data saved in the database, as an object.

  Author

  BigfootDS

insertOne

• insertOne(collectionName, dataObject): Promise<object>

• Insert an object of data into the database, following a document schema, and return the saved object of data.

  Parameters

  • collectionName: string

    The name of the collection to insert the data into.
  • dataObject: object

    The data to be inserted.

  Returns Promise<object>

  The data saved in the database, as an object.

  Author

  BigfootDS

removeIndex

• removeIndex(collectionName, fieldNames): Promise<void>

• Remove a collection's index from an array of given field names.

  Parameters

  • collectionName: string

    A string of the collection name to target within the database.
  • fieldNames: string[]

    An array containing one or more fields on the collection that you'd like to remove the index from.

  Returns Promise<void>

  Promise.

  Author

  BigfootDS