Class CustomActionsBase`Abstract`

Hierarchy (View Summary)

ActionsBase
- CustomActionsBase
  - MemoryAction

Index

Constructors

Properties

_inited adapterOpts fileCpu smartExecutor

Accessors

Methods

add close ensureCollection find findOne getCollections init issetCollection remove removeCollection removeOne toggleOne update updateOne updateOneOrAdd

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

Accessors

idKey

get idKey(): string
Returns string
Inherited from ActionsBase.idKey
- Defined in base/actions.ts:25
set idKey(value: string): void
Parameters
- value: string
Returns void
Inherited from ActionsBase.idKey
- Defined in base/actions.ts:28

numberId

get numberId(): boolean
Returns boolean
Inherited from ActionsBase.numberId
- Defined in base/actions.ts:18
set numberId(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from ActionsBase.numberId
- Defined in base/actions.ts:21

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

close

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

`Abstract`ensureCollection

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

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:35

init

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

`Abstract`issetCollection

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

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:38

removeOne

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

toggleOne

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

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>
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>
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:48