Interface FileCpu

interface FileCpu {
    add(file: string, config: Add): Promise<void>;
    find(file: string, config: Find): Promise<DataInternal[]>;
    findOne(file: string, config: FindOne): Promise<false | DataInternal>;
    remove(file: string, config: Remove, one: boolean): Promise<DataInternal[]>;
    update(file: string, config: Update, one: boolean): Promise<DataInternal[]>;
}

Implemented by

CustomFileCpu

Index

Methods

add find findOne remove update

Methods

add

add(file: string, config: Add): Promise<void>
Asynchronously adds an entry to a file.
Parameters
- file: string
- config: Add
Returns Promise<void>
A promise resolving to void.
- Defined in types/fileCpu.ts:9

find

find(file: string, config: Find): Promise<DataInternal[]>
Asynchronously finds multiple entries in a file based on search criteria.
Parameters
- file: string
- config: Find
Returns Promise<DataInternal[]>
A promise resolving to an array of found entries, or false if the file does not exist.
- Defined in types/fileCpu.ts:15

findOne

findOne(file: string, config: FindOne): Promise<false | DataInternal>
Asynchronously finds one entry in a file based on search criteria.
Parameters
- file: string
- config: FindOne
Returns Promise<false | DataInternal>
A promise resolving to the found entry or false if not found.
- Defined in types/fileCpu.ts:21

remove

remove(file: string, config: Remove, one: boolean): Promise<DataInternal[]>
Asynchronously removes entries from a file based on search criteria.
Parameters
- file: string
- config: Remove
- one: boolean
  If true, removes only the first matching entry.
Returns Promise<DataInternal[]>
A promise resolving to true if at least one entry was removed, otherwise false.
- Defined in types/fileCpu.ts:28

update

update(file: string, config: Update, one: boolean): Promise<DataInternal[]>
Asynchronously updates entries in a file based on search criteria and an updater function or object.
Parameters
- file: string
- config: Update
- one: boolean
  If true, updates only the first matching entry.
Returns Promise<DataInternal[]>
A promise resolving to true if at least one entry was updated, otherwise false.
- Defined in types/fileCpu.ts:35