@gimenete/type-writer

中文文档
0.1.5发布于 2020/03/18MITCommonJS近 30 天下载 5986

Generate type definitions for TypeScript, Flow, PropTypes, etc. by using examples of the data

原始使用文档

📇 Typewriter

Generate type definitions for TypeScript, Flow, PropTypes, etc. by using examples of the data

Installing

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

Example

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()

Output:

# 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 共发布 6 个版本,首次发布于 2018/07/28;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.1.5latest2020/03/186 年前
0.1.42019/12/276 年前
0.1.32018/07/318 年前
0.1.22018/07/318 年前
0.1.12018/07/318 年前
0.1.02018/07/288 年前

关于 @gimenete/type-writer 的常见问题

@gimenete/type-writer 是什么?

Generate type definitions for TypeScript, Flow, PropTypes, etc. by using examples of the data

如何安装 @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 和提交记录判断。