Class Databases<C>

Type parameters

C: Collections

Hierarchy

Databases<C>
- Databases

Index

Constructors

constructor

Properties

directory

Methods

Constructors

constructor

new Databases<C>(options: DatabasesOptions<C>): Databases<C>

Inherited from Databases.constructor
- Defined in packages/db/src/meta/pouch/adapters/base.ts:34
Type parameters
- C: Collections
Parameters
- options: DatabasesOptions<C>
Returns Databases<C>

Properties

Private directory

directory: string

Methods

createDatabase

createDatabase(resource: any): Database<{}>

Overrides Databases.createDatabase
- Defined in packages/db/src/meta/pouch/adapters/fs.ts:35
Parameters
- resource: any
Returns Database<{}>

delete

delete<N, T>(collectionName: N, references: (undefined | Pick<Record<T>, "_id">)[]): Promise<void>

Inherited from Databases.delete
- Defined in packages/db/src/meta/pouch/adapters/base.ts:217
Type parameters
- N: string
- T
Parameters
- collectionName: N
- references: (undefined | Pick<Record<T>, "_id">)[]
Returns Promise<void>

every

every<N, T>(collectionName: N): Promise<SavedRecord<T>[]>

Inherited from Databases.every
- Defined in packages/db/src/meta/pouch/adapters/base.ts:83
Type parameters
- N: string
- T
Parameters
- collectionName: N
Returns Promise<SavedRecord<T>[]>

jsondownpouch

jsondownpouch(opts: any, callback: any): any

- Defined in packages/db/src/meta/pouch/adapters/fs.ts:40
Parameters
- opts: any
- callback: any
Returns any

retrieve

retrieve<N, T>(collectionName: N, records: (undefined | Pick<Record<T>, "_id">)[]): Promise<(undefined | SavedRecord<T>)[]>

Inherited from Databases.retrieve
- Defined in packages/db/src/meta/pouch/adapters/base.ts:100
Type parameters
- N: string
- T
Parameters
- collectionName: N
- records: (undefined | Pick<Record<T>, "_id">)[]
Returns Promise<(undefined | SavedRecord<T>)[]>

save

save<N, T>(collectionName: N, records: (undefined | Record<T>)[], options?: { overwrite?: undefined | boolean }): Promise<(undefined | SavedRecord<T>)[]>

Inherited from Databases.save
- Defined in packages/db/src/meta/pouch/adapters/base.ts:145
Type parameters
- N: string
- T
Parameters
- collectionName: N
- records: (undefined | Record<T>)[]
- options: { overwrite?: undefined | boolean } = ...
  - Optional overwrite?: undefined | boolean
Returns Promise<(undefined | SavedRecord<T>)[]>

search

search<N, T>(collectionName: N, options: FindRequest<{}>): Promise<SavedRecord<T>[]>

Inherited from Databases.search
- Defined in packages/db/src/meta/pouch/adapters/base.ts:132
Type parameters
- N: string
- T
Parameters
- collectionName: N
- options: FindRequest<{}>
Returns Promise<SavedRecord<T>[]>

setup

setup(settings: DatabasesSettings): void

Overrides Databases.setup
- Defined in packages/db/src/meta/pouch/adapters/fs.ts:26
Parameters
- settings: DatabasesSettings
Returns void

Generated using TypeDoc