Class DeleteOperation<T>

This operation deletes an object from the database.

Usage

See Datastore.delete.

Type parameters

T: Model<T>

The model of the Datastore. T must extend from Model.

Hierarchy

DeleteOperation

Implements

BaseOperation<T>

Index

Constructors

constructor

Properties

_id
_store

Methods

Constructors

constructor

new DeleteOperation(store: Datastore<T>, id?: string): DeleteOperation

- Defined in database/operations/delete.operation.ts:18
Parameters
- store: Datastore<T>
  
  The datastore where the deletion operation takes place.
- Optional id: string
  
  Identifier of an object to delete.
Returns DeleteOperation

Properties

Private _id

_id: string

Identifier of an object to delete.

Private _store

_store: Datastore<T>

The datastore where the operation takes place.

Methods

delete

delete(): Promise<void>

- Defined in database/operations/delete.operation.ts:60
Runs the deletion operation. Same as run

Returns Promise<void>

id

id(id: string): this

- Defined in database/operations/delete.operation.ts:44
Deletes item with this id if run or delete is called.

Parameters
- id: string
  
  Identifier of an item to delete.
Returns this

Returns this operation again, to make chaining methods possible.

item

item(item: T): this

- Defined in database/operations/delete.operation.ts:34
Deletes this item if run or delete is called.

Parameters
- item: T
  
  An item to delete.
Returns this

Returns this operation again, to make chaining methods possible.

run

run(): Promise<void>

- Defined in database/operations/delete.operation.ts:52
Runs the deletion operation.

Returns Promise<void>

Generated using TypeDoc