Skip to content

Commit

Permalink
feat: init package
Browse files Browse the repository at this point in the history
  • Loading branch information
findlay-best-wishes committed Sep 26, 2022
1 parent 341167b commit 205f15f
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
6 changes: 3 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ Gain information ( such as type or comment ) of some type from typescript projec
# Install

```shell
npm install easy-type
npm install @findlay-best-wishes/easy-type
```

# Usage

```javascript
const { getTypeOption } = require('easy-type')
const { getTypeOption } = require('@findlay-best-wishes/easy-type')

const { name, type, comment } = getTypeOption({
entryFile: 'test.ts',
Expand All @@ -22,7 +22,7 @@ const { name, type, comment } = getTypeOption({

```javascript
// gain mutiple type information
const { getTypeOption } = require('easy-type')
const { getTypeOption } = require('@findlay-best-wishes/easy-type')

const { Props, State } = getTypeOption({
entryFile: 'button.ts',
Expand Down
6 changes: 3 additions & 3 deletions docs/Readme.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
# 安装

``` shell
npm install easy-type
npm install @findlay-best-wishes/easy-type
```

# 用法

```javascript
const { getTypeOption } = require('easy-type')
const { getTypeOption } = require('@findlay-best-wishes/easy-type')

const { name, type, comment } = getTypeOption({
entryFile: 'test.ts',
Expand All @@ -22,7 +22,7 @@ const { name, type, comment } = getTypeOption({

```javascript
// 获取多个类型信息
const { getTypeOption } = require('easy-type')
const { getTypeOption } = require('@findlay-best-wishes/easy-type')

const { Props, State } = getTypeOption({
entryFile: 'button.ts',
Expand Down
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "easy-type",
"name": "@findlay-best-wishes/easy-type",
"version": "0.0.0-development",
"description": "gain information of some type from typescript project",
"main": "dist/index.js",
Expand Down Expand Up @@ -30,6 +30,9 @@
}
]
},
"publishConfig": {
"access": "public"
},
"author": "findlay-best-wishes",
"repository": "https://github.com/findlay-best-wishes/easy-type",
"license": "ISC",
Expand Down

0 comments on commit 205f15f

Please sign in to comment.