# @midwayjs/spec-builder

> FaaS 标准 Spec 解析工具，以及用于其他平台 spec 转换的基础定义。

Latest version **0.1.5** (published 2019-12-22) · 0 weekly downloads

## Install

```sh
npm install @midwayjs/spec-builder
pnpm add @midwayjs/spec-builder
yarn add @midwayjs/spec-builder
bun add @midwayjs/spec-builder
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2019-12-22 |
| First published | 2019-12-09 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 17.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | czy88840616 |

## Links

- npm: https://www.npmjs.com/package/@midwayjs/spec-builder
- npm.io page: https://npm.io/package/@midwayjs/spec-builder

## Dependencies (3)

- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.0
- [json-cycle](https://npm.io/package/json-cycle.md) ^1.3.0

## Recent versions

- 0.1.5 (latest) — 2019-12-22
- 0.1.3 — 2019-12-18
- 0.1.2 — 2019-12-13
- 0.1.1 — 2019-12-13
- 0.1.0 — 2019-12-13
- 0.0.10 — 2019-12-11
- 0.0.9 — 2019-12-11
- 0.0.8 — 2019-12-11
- 0.0.7 — 2019-12-11
- 0.0.6 — 2019-12-11
- 0.0.5 — 2019-12-10
- 0.0.4 — 2019-12-10
- 0.0.3 — 2019-12-10
- 0.0.2 — 2019-12-10
- 0.0.1 — 2019-12-09

## README

# spec builder

FaaS 标准 Spec 解析工具，以及用于其他平台 spec 转换的基础定义。

## API

**transform**

根据传入的标准 spec 文件和一个生成器类，转换成标准的 JSON 格式。

```ts
transform(sourcefilePath: string, builderCls?);
```

- sourcefilePath 原始 spec 文件地址
- builderCls 转换的 class(非实例)，默认为 SpecBuilder 类型，可以继承后传入

**generate**

```ts
generate(sourceFilePath: string, targetFilePath: string, builderCls?);
```

- sourcefilePath 原始 spec 文件地址
- targetFilePath 转换后的 spec 文件地址
- builderCls 转换的 class(非实例)，默认为 SpecBuilder 类型，可以继承后传入

**saveYaml**

保存 JSON 到 yml 文件

```ts
saveYaml(filePath: string, target：object);
```

- filePath 需要保存到的 yml 文件路径
- 保存到 yml 文件的 JSON 内容

---
_Source: https://npm.io/package/@midwayjs/spec-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
