Interface CrudInterface

This CRUD interface is used by the manager to abstract storage.

Hierarchy

CrudInterface
- Storage

Index

Methods

delete insert select update

Methods

delete

delete<T>(table): Promise<boolean>
Empties a table completely.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to delete everything.
Returns Promise<boolean>
- Defined in src/types.ts:190
delete<T>(table, filter): Promise<boolean>
Delete data in a table, based on a filter.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to delete in.
- filter: Partial<DataTypes[T]>
  
  An object to filter data.
Returns Promise<boolean>
- Defined in src/types.ts:198

insert

insert<T>(table, value): Promise<number>
Inserts a value in the database and returns its id.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to insert.
- value: OmitId<DataTypes[T]>
  
  What to insert.
Returns Promise<number>
- Defined in src/types.ts:134
insert<T>(table, values): Promise<boolean>
Inserts multiple values in the database.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to insert.
- values: OmitId<DataTypes[T]>[]
  
  What to insert.
Returns Promise<boolean>
- Defined in src/types.ts:142

select

select<T>(table): Promise<null | DataTypes[T][]>
Gets all data from a table in the database.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to get from.
Returns Promise<null | DataTypes[T][]>
- Defined in src/types.ts:149
select<T>(table, id): Promise<null | DataTypes[T]>
Gets specific data from a table in the database.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to get from.
- id: Id
  
  What to get.
Returns Promise<null | DataTypes[T]>
- Defined in src/types.ts:157
select<T>(table, filter): Promise<null | DataTypes[T][]>
Gets data from a table in the database with a filter.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to get from.
- filter: Partial<DataTypes[T]>
  
  An object to filter data.
Returns Promise<null | DataTypes[T][]>
- Defined in src/types.ts:165

update

update<T>(table, id, value): Promise<boolean>
Updates data in a table.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to update.
- id: Id
  
  What to update.
- value: DataTypes[T]
  
  How to update.
Returns Promise<boolean>
- Defined in src/types.ts:174
update<T>(table, filter, value): Promise<boolean>
Updates data in a table.
Type Parameters
- T extends keyof DataTypes
Parameters
- table: T
  
  Where to update.
- filter: Partial<DataTypes[T]>
  
  An object to filter data.
- value: Partial<DataTypes[T]>
  
  How to update.
Returns Promise<boolean>
- Defined in src/types.ts:183

Interface CrudInterface

Hierarchy

Index

Methods

Methods

delete

Type Parameters

T extends keyof DataTypes

Parameters

table: T

Returns Promise<boolean>

Type Parameters

T extends keyof DataTypes

Parameters

table: T

filter: Partial<DataTypes[T]>

Returns Promise<boolean>

insert

Type Parameters

T extends keyof DataTypes

Parameters

table: T

value: OmitId<DataTypes[T]>

Returns Promise<number>

Type Parameters

T extends keyof DataTypes

Parameters

table: T

values: OmitId<DataTypes[T]>[]

Returns Promise<boolean>

select

Type Parameters

T extends keyof DataTypes

Parameters

table: T

Returns Promise<null | DataTypes[T][]>

Type Parameters

T extends keyof DataTypes

Parameters

table: T

id: Id

Returns Promise<null | DataTypes[T]>

Type Parameters

T extends keyof DataTypes

Parameters

table: T

filter: Partial<DataTypes[T]>

Returns Promise<null | DataTypes[T][]>

update

Type Parameters

T extends keyof DataTypes

Parameters

table: T

id: Id

value: DataTypes[T]

Returns Promise<boolean>

Type Parameters

T extends keyof DataTypes

Parameters

table: T

filter: Partial<DataTypes[T]>

value: Partial<DataTypes[T]>

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page