Class TessraCollection

Class of Tessra Collection Performs all the functions of TessraDB collections (find, delete, insert, update, etc.)

Hierarchy

TessraCollection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TessraCollection(name: string, path: string): TessraCollection

- Defined in collection.ts:15
Parameters
- name: string
- path: string
Returns TessraCollection

Properties

Private #locked

#locked: boolean = false

name

name: string

path

path: string

Methods

Private #init

#init(): void

- Defined in collection.ts:23
Inititalize the collection

Returns void

Private #isFiltValid

#isFiltValid(filt: Object, obj: Object): boolean

- Defined in collection.ts:33
checking the object for compliance with the filter

Parameters
- filt: Object
  
  filter for object find({id:1, type:"help"})
- obj: Object
  
  object to compare
Returns boolean

find

find(filter: Object): Promise<collectionDocument[]>

- Defined in collection.ts:44
function to find documents by filter in collection

Parameters
- filter: Object
  
  filter object find({id:1, type:"help"})
Returns Promise<collectionDocument[]>

findOne

findOne(filter: Object): Promise<collectionDocument>

- Defined in collection.ts:69
function to find one document by filter in collection

Parameters
- filter: Object
  
  filter object find({id:1, type:"help"})
Returns Promise<collectionDocument>

insert

insert(doc: collectionDocument): Promise<void>

- Defined in collection.ts:96
Insert a document to collection

Parameters
- doc: collectionDocument
  
  Document to insert
Returns Promise<void>

insertMany

insertMany(docArray: collectionDocument[]): Promise<void>

- Defined in collection.ts:125
Insert a many documents to collection

Parameters
- docArray: collectionDocument[]
  
  array of documents to insert
Returns Promise<void>

replace

replace(filter: Object, doc: collectionDocument): Promise<void>

- Defined in collection.ts:189
Replace document in collection

Parameters
- filter: Object
  
  Filter
- doc: collectionDocument
  
  Document to replace
Returns Promise<void>

replaceMany

replaceMany(filter: Object, doc: collectionDocument): Promise<void>

- Defined in collection.ts:156
Replace documents in collection

Parameters
- filter: Object
  
  Filter
- doc: collectionDocument
  
  Document to insert
Returns Promise<void>

Generated using TypeDoc