---
name: "deletePet"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "deletePet - 删除宠物"
---

## deletePet

> [VERSION] @ray-js/ray >= 1.6.27

### 描述

删除宠物

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `data` | `PetDelete` | 是 | 请求参数：id 宠物 id，ownerId 家庭 id，dataType 业务数据类型 |

### 返回值

类型: `Promise<boolean>`

Promise，resolve 值为是否删除成功（boolean）

### 引用对象

##### `type` PetDelete

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `id` | `number` | 宠物id |
| `ownerId` | `string` | 家庭id |
| `dataType` | `string` | 业务数据类型 |


### 示例代码

#### 请求示例

```typescript
import { deletePet } from '@ray-js/ray';

deletePet({
  id: 1,
  ownerId: 'xxxx',
});
```

#### 返回示例

```json
true
```