---
name: "getPetBreedList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "getPetBreedList - 获取宠物品种列表"
---

## getPetBreedList

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

### 描述

获取宠物品种列表

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `data` | `GetPetBreedList` | 是 | 请求参数：petType 为 cat 或 dog |

### 返回值

类型: `Promise<Object[]>`

Promise，resolve 值为品种列表（code、多语言名称、首字母等）
| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `breedCode` | `string` | 品种code |
| `name` | `string` | 品种多语言名称 |
| `headerChar` | `string` | 宠物名称首字母，中英文才有 |

### 引用对象

##### `type` GetPetBreedList

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `petType` | `"cat" \| "dog"` | 宠物品种类型，cat-猫，dog-狗 |


### 示例代码

#### 请求示例

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

getPetBreedList({
  petType: 'dog',
});
```

#### 返回示例

```json
[
  {
    "breedCode": "xxx",
    "name": "阿根廷杜高犬",
    "headerChar": "A"
  }
]
```