deleteItem
Spec
async deleteItem(
tnmInput: TynamoDeleteItemInput<TSource>
): Promise<TynamoDeleteItemOutput<TSource>>
Input
export interface TynamoDeleteItemInput<TSource> {
Key: Partial<TSource>;
ExpressionAttributeValues?: any;
// Derived from DynamoDB.
ReturnValues?: ReturnValue;
ReturnConsumedCapacity?: ReturnConsumedCapacity;
ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics;
ConditionExpression?: ConditionExpression;
ExpressionAttributeNames?: ExpressionAttributeNameMap;
}
Name
Type
Info
Key
@DynamoEntity
The key of item.
ExpressionAttributeValues
@DynamoEntity
Value used for expression.
Output
export interface TynamoUpdateItemOutput<TSource> {
Attributes?: TSource;
// Derived from DynamoDB.
$response: AWS.Response<DeleteItemOutput, AWS.AWSError>;
ConsumedCapacity?: ConsumedCapacity;
ItemCollectionMetrics?: ItemCollectionMetrics;
}
Name
Type
Info
Attributes
@DynamoEntity
Result of deleteItem
operation.
Example
@DynamoEntity()
class Cat {
@DynamoProperty({ keyType: KeyType.hash })
id!: number;
@DynamoProperty({ keyType: KeyType.attr })
name!: string;
constructor(id: number, name: string) {
this.id = id;
this.name = name;
}
}
const tynamo: Tynamo = new Tynamo({
region: "ap-northeast-2",
endpoint: "http://localhost:8000"
});
const tynamoTable = tynamo.getTableOf(Cat);
await tynamoTable.deleteItem({
Key: new Cat(666, ""),
});
Last updated
Was this helpful?