Class DBCollection

Class for creating collections of structured documents

Hierarchy

DBCollection

Index

Constructors

constructor

Properties

Other Methods

Query Methods

find

Constructors

constructor

new DBCollection(db: DB, schema: SchemaTemplateType): DBCollection

- Defined in collection.ts:32
Create a structured collection of documents

Parameters
- db: DB
  
  Database reference
- schema: SchemaTemplateType
  
  Schema for content to adhere to
Returns DBCollection

Properties

Readonly col_

col_: Debugger

Debugger variable

Readonly db

db: DB

Reference to the DB object

docs

docs: DBDoc[]

Document array

Readonly name

name: string

Name of the collection

reactiveIndexed

reactiveIndexed: Map<Query[] | QueryBuilder, { docs: DBDoc[] }> = ...

Map for reactive query results

Readonly schema

schema: {}

Schema every document should adhere to

Type declaration

[key: string]: any

Other Methods

emitEvent

emitEvent(event: MemsDBEvent): void

- Defined in collection.ts:192
Emit an event to the attached database

Parameters
- event: MemsDBEvent
  
  Event to emit
Returns void

id

id(idStr: string): undefined | DBDoc

- Defined in collection.ts:54
Find a specific document by its id

Parameters
- idStr: string
  
  ID to filter by
Returns undefined | DBDoc

insert

insert(opts: CollectionInsertOpts): DBDoc

- Defined in collection.ts:169
Alias of insertOne

Parameters
- opts: CollectionInsertOpts
  
  Insert document options
Returns DBDoc

insertMany

insertMany(opts: CollectionInsertManyOpts): DBCollection

- Defined in collection.ts:177
Add any amount of new documents to the collection

Parameters
- opts: CollectionInsertManyOpts
Returns DBCollection

insertOne

insertOne(opts: CollectionInsertOpts): DBDoc

- Defined in collection.ts:107
Insert a new document into the array. Defaults will be loaded from the schema

Parameters
- opts: CollectionInsertOpts
  
  Insert document options
Returns DBDoc

toJSON

toJSON(): string

- Defined in collection.ts:206
Custom handler for toJSON to avoid recursion of toString and toJSON

Returns string

toString

toString(): string

- Defined in collection.ts:199
Custom handler for toString to avoid recursion of toString and toJSON

Returns string

Query Methods

find

find(opts?: CollectionFindOpts): DBDoc[]

- Defined in collection.ts:72
Run a set of queries to filter documents

Parameters
- opts: CollectionFindOpts = ...
Returns DBDoc[]

Generated using TypeDoc