# runtime-generated-type

> runtime-generated-type

Latest version **0.0.2** (published 2023-06-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install runtime-generated-type
pnpm add runtime-generated-type
yarn add runtime-generated-type
bun add runtime-generated-type
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-06-02 |
| First published | 2023-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 61.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | proc07 |
| Maintainers | zhangli07 |

## Links

- npm: https://www.npmjs.com/package/runtime-generated-type
- Repository: https://github.com/proc07/runtime-generated-type
- Homepage: https://github.com/proc07/runtime-generated-type#readme
- Issues: https://github.com/proc07/runtime-generated-type/issues
- npm.io page: https://npm.io/package/runtime-generated-type

## Recent versions

- 0.0.2 (latest) — 2023-06-02
- 0.0.1 — 2023-05-17

## README

<h1 align="center">runtime-generated-type</h1>

<p align="center">
Generates typescript code when sending the request interface.
</p>

<p align="center">
<a href="https://www.npmjs.com/package/runtime-generated-type"><img src="https://img.shields.io/npm/v/runtime-generated-type?color=a1b858&label=" alt="NPM version"></a></p>


## Install
```bash
$ npm install --save-dev runtime-generated-type
```

## Getting Started

- vite

```javascript
import { defineConfig } from 'vite'
import {createRuntimeGeneratedType} from 'runtime-generated-type'
import path from 'path'

export default defineConfig({
  server: {
    proxy: {
      '/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/api/, ''),
        configure: createRuntimeGeneratedType({
          dataSource: '', // 指定接口返回数据的位置
          outputPath: path.resolve(__dirname, './src/types.ts'),
          baseUrl: '/api/*',
        }),
      },
    }
  }
})
```

- react-create-app -> setupProxy.js
```javascript
const path = require('path')
// "http-proxy-middleware": "3.0.0-beta.1"
const {createProxyMiddleware} = require('http-proxy-middleware')
const {createRuntimeGeneratedType} = require('runtime-generated-type')

const runtimeGeneratedTypePlugin = createRuntimeGeneratedType({
  dataSource: '', // 指定接口返回数据的位置
  outputPath: path.resolve(__dirname, './types.ts'),
  baseUrl: '/api/*',
})

module.exports = function(app) {
  app.use(
    createProxyMiddleware({
      pathFilter: '/api',
      target: 'http://jsonplaceholder.typicode.com',
      changeOrigin: true,
      pathRewrite: {'^/api' : ''},
      plugins: [runtimeGeneratedTypePlugin],
    })
  );
};
```

## Configuration

| 参数 | 类型 | 必填 | 参数说明 | 示例 |
| :--- | :--- | :--- | :--- | :--- |
| outputPath | String | true | 生成文件路径 | path.resolve(__dirname, './src/types.ts') |
| baseUrl | String | true | 配置请求接口地址的统一前缀  | '/api/*' (*号自动匹配任意字符) |
| dataSource | String | false | 指定生成类型数据源位置 | 'data.item' |
| genOnce | Boolean | false | 每个接口仅生成一次类型 |   |
| matching | Array<string> | false | 匹配动态参数请求接口 | ['/posts/*/comments'] |
| prefix | boolean | false | typeName 添加前缀 | Get \| Post \| Put \| Delete ... |

Request url to generate type name matching rules

- GET:    /api/v1/team/department/frontGroup/:id       -> TeamDepartmentFrontGroup
- GET:    /api/v1/team/department/endGroup/:id         -> TeamDepartmentEndGroup
- GET:    /api/v1/team/department/endGroup/:id/details -> TeamDepartmentEndGroupDetails
- GET:    /api/v1/teamMember  -> GetTeamMember
- PUT:    /api/v1/teamMember  -> PutTeamMember
- DELETE: /api/v1/teamMember  -> DeleteTeamMember
- POST:   /api/workflow/:id/inter/search -> PostWorkflowInterSearch
- POST:   /api/system/:id/inter/search   -> PostSystemInterSearch
- GET:    /api/user/:id/inter/search     -> GetUserInterSearch

## License

[MIT](./LICENSE) License © 2023 [Proc Zhang](https://github.com/proc07)

---
_Source: https://npm.io/package/runtime-generated-type · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._