Interface DeleteResult<TRow>

Represents the result of delete and deleteIfVersion methods.

Type Parameters

  • TRow = AnyRow

    Type of table row instance, defaults to AnyRow

Hierarchy

Properties

consumedCapacity? existingModificationTime? existingRow? existingVersion? success

Properties

Optional Readonly consumedCapacity

consumedCapacity?: ConsumedCapacity

Capacity consumed by this operation, see ConsumedCapacity. Undefined if using on-premises service or if this is a result of a put or a delete sub-operation as part of WriteMultipleResult.

Optional Readonly existingModificationTime

existingModificationTime?: Date

Existing modification time if available, otherwise undefined. This value will be available only if returnExisting was set to true and under one of the conditions described in delete.

Since

5.3.0

Optional Readonly existingRow

existingRow?: TRow

Existing row value if available, otherwise undefined. This value will be available only if returnExisting was set to true and under one of the conditions described in delete.

Optional Readonly existingVersion

existingVersion?: RowVersion

Existing RowVersion if available, otherwise undefined. This value will be available only if returnExisting was set to true and under one of the conditions described in delete.

Readonly success

success: boolean

Whether the delete operation was successful, as described in delete.

Settings

Member Visibility

Theme

Generated using TypeDoc