# @elgato/schemas 中文文档

规范地址：https://npmcn.com/package/%40elgato/schemas/

版本：0\.6\.0
npm 元数据更新时间：2026-10-29T14:36:57.001Z
中文译文更新时间：2026-11-13T12:24:10.163Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40elgato/schemas
原文对照：https://npmcn.com/package/%40elgato/schemas/?lang=original
项目主页：https://github.com/elgatosf/streamdeck/tree/main/packages/schemas#readme
源码仓库：https://github.com/elgatosf/streamdeck

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：537 kB，39 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2024-02-12T17:59:21.280Z
- 最新版本发布：2026-10-29T14:36:56.223Z
- 近 30 天下载量：88527（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：43（近 12 个月 9 个）

## 中文简介

收集策略和 TypeScript 声明,支持创建和验证 Stream Deck SDK 文件

## 安装

```sh
npm install @elgato/schemas
```

也可以使用：`pnpm add @elgato/schemas`、`yarn add @elgato/schemas`、`bun add @elgato/schemas`

## README

[![Stream Deck SDK banner](https://images.ctfassets.net/8j9xr8kwdre8/1ihLKCwNWEfPixs27dq0c0/130be66a5173f332e4caa892a3462893/banner.png)](https://docs.elgato.com/sdk)

# 示马斯

[![Schemas npm package](https://img.shields.io/npm/v/%40elgato/schemas?logo=npm&logoColor=white)](https://www.npmjs.com/package/@elgato/schemas) [![SDK documentation](https://img.shields.io/badge/Documentation-2ea043?labelColor=grey&logo=gitbook&logoColor=white)](https://docs.elgato.com/sdk) [![Join the Marketplace Makers Discord](https://img.shields.io/badge/Marketplace%20Makers-5662f6?labelColor=grey&logo=discord&logoColor=white)](https://discord.gg/GehBUcu627) [![Elgato homepage](https://img.shields.io/badge/Elgato-3431cf?labelColor=grey&logo=Elgato)](https://elgato.com/)

Collection of schemas, and TypeScript 声明,支持Stream Deck SDK文件的创建和验证.

```bash
npm install @elgato/schemas
```

## 流出地标

### 插件

#### 声明

用于定义 Stream Deck 插件的 Manific JSON 文件 .

```ts
// TypeScript type.
import { type Manifest } from "@elgato/schemas/streamdeck/plugins";
```

```js
// Schema as an object, using import attributes.
import manifest from "@elgato/schemas/streamdeck/plugins/manifest.json" with { type: "json" };
```

```
https://schemas.elgato.com/streamdeck/plugins/manifest.json
```

#### 版式

布局 JSON 文件定义了 Stream Deck +, Stream Deck + XL 和 Stream Deck Neo 上的动作布局.

```ts
// TypeScript type.
import { type Layout } from "@elgato/schemas/streamdeck/plugins";
```

```js
// Schema as an object, using import attributes.
import layout from "@elgato/schemas/streamdeck/plugins/layout.json" with { type: "json" };
```

```
https://schemas.elgato.com/streamdeck/plugins/layout.json
```

## 使用量

Schemas可以直接在JSON文件中被引用,提供intellisense和验证,使用 `$schema` 属性,例如:

```jsonc
{
    "$schema": "https://schemas.elgato.com/streamdeck/plugins/manifest.json",
    "Name": "Wave Link",
    "Version": "1.9.0.0",
    "Author": "Elgato",
    // ...
}
```

## 关键词

自定义关键字在提供的计划中也可以被直接导入来帮助构建验证符,例如: `Ajv`。请注意,自定义的关键词定义只登记关键词,不会提供验证.

```ts
import { keywordDefinitions } from "@elgato/schemas";
import Ajv from "ajv";

// add the "filePath" keyword (excluding validation)
ajv.addKeyword(keywordDefinitions.filePath);
```

## 常见问题

### @elgato/schemas 是什么？

收集策略和 TypeScript 声明,支持创建和验证 Stream Deck SDK 文件

### 如何安装 @elgato/schemas？

在项目目录运行 npm install @elgato/schemas，或使用 pnpm add / yarn add / bun add。

### @elgato/schemas 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @elgato/schemas 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @elgato/schemas 可以商用吗？

@elgato/schemas 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @elgato/schemas 的下载量有多少？

根据 npm 官方下载统计，@elgato/schemas 在 2026/10/14 – 2026/11/12 这 30 天内被下载 88,527 次，日均约 2,951 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @elgato/schemas 还在维护吗？

最新版本 0\.6\.0 发布于 2026/10/29（15 天前）；至今共发布 43 个版本，其中过去 12 个月发布了 9 个；首次发布于 2024/02/13。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。