Class CustomActionsBase`Abstract`

Hierarchy (View Summary)

ActionsBase
- CustomActionsBase
  - MemoryAction

Index

Constructors

constructor

new CustomActionsBase(): CustomActionsBase

Returns CustomActionsBase

Inherited from ActionsBase.constructor

Properties

_inited

_inited: boolean = true

adapterOpts

adapterOpts: AdapterOpts = ...

fileCpu

fileCpu: CustomFileCpu

smartExecutor

smartExecutor: boolean = false

version

version: string = ...

Methods

add

add(query: Add): Promise<Arg<Data>>
Add a new entry to the specified database.
Parameters
- query: Add
Returns Promise<Arg<Data>>
Overrides ActionsBase.add
- Defined in base/custom.ts:14

beginTransaction

beginTransaction(id: string): Promise<TransactionHandle>
Parameters
- id: string
Returns Promise<TransactionHandle>
Inherited from ActionsBase.beginTransaction
- Defined in base/actions.ts:38

bulkAdd

bulkAdd(config: BulkAdd): Promise<DataInternal[]>
Parameters
- config: BulkAdd
Returns Promise<DataInternal[]>
Inherited from ActionsBase.bulkAdd
- Defined in base/actions.ts:102

close

close(...args: any[]): Promise<void>
Parameters
- ...args: any[]
Returns Promise<void>
Inherited from ActionsBase.close
- Defined in base/actions.ts:23

commitTransaction

commitTransaction(handle: TransactionHandle): Promise<void>
Parameters
- handle: TransactionHandle
Returns Promise<void>
Inherited from ActionsBase.commitTransaction
- Defined in base/actions.ts:42

count

count(config: Count): Promise<number>
Parameters
- config: Count
Returns Promise<number>
Inherited from ActionsBase.count
- Defined in base/actions.ts:98

createIndex

createIndex(config: CreateIndex): Promise<void>
Parameters
- config: CreateIndex
Returns Promise<void>
Inherited from ActionsBase.createIndex
- Defined in base/actions.ts:50

`Abstract`ensureCollection

ensureCollection(collection: string): Promise<boolean>
Parameters
- collection: string
Returns Promise<boolean>
Inherited from ActionsBase.ensureCollection
- Defined in base/actions.ts:26

find

find(query: Find): Promise<Data[]>
Find entries in the specified database based on search criteria.
Parameters
- query: Find
Returns Promise<Data[]>
Overrides ActionsBase.find
- Defined in base/custom.ts:25

findOne

findOne(query: FindOne): Promise<Data>
Find the first matching entry in the specified database based on search criteria.
Parameters
- query: FindOne
Returns Promise<Data>
Overrides ActionsBase.findOne
- Defined in base/custom.ts:36

`Abstract`getCollections

getCollections(): Promise<string[]>
Returns Promise<string[]>
Inherited from ActionsBase.getCollections
- Defined in base/actions.ts:25

init

init(...args: any[]): Promise<void>
Parameters
- ...args: any[]
Returns Promise<void>
Inherited from ActionsBase.init
- Defined in base/actions.ts:22

`Abstract`issetCollection

issetCollection(collection: string): Promise<boolean>
Parameters
- collection: string
Returns Promise<boolean>
Inherited from ActionsBase.issetCollection
- Defined in base/actions.ts:27

remove

remove(query: Remove): Promise<DataInternal[]>
Remove entries from the specified database based on search criteria.
Parameters
- query: Remove
Returns Promise<DataInternal[]>
Overrides ActionsBase.remove
- Defined in base/custom.ts:62

`Abstract`removeCollection

removeCollection(collection: string): Promise<boolean>
Parameters
- collection: string
Returns Promise<boolean>
Inherited from ActionsBase.removeCollection
- Defined in base/actions.ts:28

removeIndex

removeIndex(config: RemoveIndex): Promise<void>
Parameters
- config: RemoveIndex
Returns Promise<void>
Inherited from ActionsBase.removeIndex
- Defined in base/actions.ts:54

removeOne

removeOne(query: Remove): Promise<DataInternal | null>
Remove the first matching entry from the specified database based on search criteria.
Parameters
- query: Remove
Returns Promise<DataInternal | null>
Overrides ActionsBase.removeOne
- Defined in base/custom.ts:70

rollbackTransaction

rollbackTransaction(handle: TransactionHandle): Promise<void>
Parameters
- handle: TransactionHandle
Returns Promise<void>
Inherited from ActionsBase.rollbackTransaction
- Defined in base/actions.ts:46

toggleOne

toggleOne(config: ToggleOne): Promise<ToggleOneResult<DataInternal>>
Parameters
- config: ToggleOne
Returns Promise<ToggleOneResult<DataInternal>>
Inherited from ActionsBase.toggleOne
- Defined in base/actions.ts:78

update

update(query: Update): Promise<DataInternal[]>
Update entries in the specified database based on search criteria and an updater function or object.
Parameters
- query: Update
Returns Promise<DataInternal[]>
Overrides ActionsBase.update
- Defined in base/custom.ts:45

updateOne

updateOne(query: Update): Promise<DataInternal | null>
Update the first matching entry in the specified database based on search criteria and an updater function or object.
Parameters
- query: Update
Returns Promise<DataInternal | null>
Overrides ActionsBase.updateOne
- Defined in base/custom.ts:53

updateOneOrAdd

updateOneOrAdd(
config: VQueryT.UpdateOneOrAdd,
): Promise<UpdateOneOrAddResult<DataInternal>>
Parameters
- config: VQueryT.UpdateOneOrAdd
Returns Promise<UpdateOneOrAddResult<DataInternal>>
Inherited from ActionsBase.updateOneOrAdd
- Defined in base/actions.ts:58