# deleteItem

### Spec

```typescript
async deleteItem(
    tnmInput: TynamoDeleteItemInput<TSource>
): Promise<TynamoDeleteItemOutput<TSource>>
```

### Input&#x20;

```typescript
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. |

{% hint style="info" %}
Unlisted param is derived from `DynamoDB`.

Check [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html) for more information.
{% endhint %}

### Output

```typescript
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. |

{% hint style="info" %}
Unlisted param is derived from `DynamoDB`.

Check [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html) for more information.
{% endhint %}

### Example

```typescript
@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, ""),
});
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://aerocode.gitbook.io/tynamo/tynamo-1/create-tynamo/tynamotable/deleteitem.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
