# @gimenete/type-writer 中文文档

规范地址：https://npmcn.com/package/%40gimenete/type-writer/

版本：0\.1\.5
npm 元数据更新时间：2022-04-05T14:18:03.940Z
中文译文更新时间：2026-11-16T09:04:55.905Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gimenete/type-writer
原文对照：https://npmcn.com/package/%40gimenete/type-writer/?lang=original
项目主页：https://github.com/gimenete/typewriter#readme
源码仓库：https://github.com/gimenete/typewriter

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

- 包体积（解压后）：21.9 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2018-07-27T17:51:03.895Z
- 最新版本发布：2020-03-18T09:31:55.376Z
- 近 30 天下载量：5986（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

通过使用数据实例生成类型Script、Flow、propTyps等的类型定义

## 安装

```sh
npm install @gimenete/type-writer
```

也可以使用：`pnpm add @gimenete/type-writer`、`yarn add @gimenete/type-writer`、`bun add @gimenete/type-writer`

## README

# +++ 打字机

通过使用数据实例生成类型Script、Flow、propTyps等的类型定义

## 安装

```
npm install @gimenete/type-writer
# or
yarn add @gimenete/type-writer
```

## 示例

```javascript
const TypeWriter = require('@gimenete/type-writer')
const tw = new TypeWriter()
const examples = []
examples.push({ user: { name: 'Julia' }, foo: 'bar' })
examples.push({ user: { name: 'Julia' }, foo: 1 })
examples.push({ user: { name: 'Julia' }, foo: [1, 2, 3] })
tw.add(examples, { rootTypeName: 'ProjectName' })
console.log('# TypeScript')
console.log(tw.generate('typescript'))
console.log()
console.log('# Inlined TypeScript')
console.log(tw.generate('typescript', { inlined: true }))
console.log()
console.log('# Inlined PropTypes')
console.log(tw.generate('propTypes', { inlined: true }))
console.log()
console.log('# PropTypes')
console.log(tw.generate('propTypes'))
console.log()
```

输出 :

```
# TypeScript
type ProjectNameUser = { name: string }
type ProjectName = {
  user: ProjectNameUser,
  foo: string | number | Array<number>
}


# Inlined TypeScript
{
  user: { name: string },
  foo: string | number | Array<number>
}

# Inlined PropTypes
PropTypes.shape({
  user: PropTypes.shape({ name: PropTypes.string.isRequired }).isRequired,
  foo: PropTypes.oneOfType(
    PropTypes.string,
    PropTypes.number,
    PropTypes.arrayOf(PropTypes.number)
  ).isRequired
})

# PropTypes
const ProjectNameUser = PropTypes.shape({ name: PropTypes.string.isRequired })
const ProjectName = PropTypes.shape({
  user: ProjectNameUser.isRequired,
  foo: PropTypes.oneOfType(
    PropTypes.string,
    PropTypes.number,
    PropTypes.arrayOf(PropTypes.number)
  ).isRequired
})
```

## 常见问题

### @gimenete/type-writer 是什么？

通过使用数据实例生成类型Script、Flow、propTyps等的类型定义

### 如何安装 @gimenete/type-writer？

在项目目录运行 npm install @gimenete/type-writer，或使用 pnpm add / yarn add / bun add。

### @gimenete/type-writer 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gimenete\_\_type-writer 是否存在。

### @gimenete/type-writer 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gimenete/type-writer 可以商用吗？

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

### @gimenete/type-writer 的下载量有多少？

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

### @gimenete/type-writer 还在维护吗？

最新版本 0\.1\.5 发布于 2020/03/18（6 年前）；至今共发布 6 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/07/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

