Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hustcc/miz
๐ฏ Generate fake data, Just like a person.
https://github.com/hustcc/miz
fake-data faker mock mock-data mocker
Last synced: 3 months ago
JSON representation
๐ฏ Generate fake data, Just like a person.
- Host: GitHub
- URL: https://github.com/hustcc/miz
- Owner: hustcc
- License: mit
- Created: 2017-09-14T05:04:03.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-04T07:47:37.000Z (over 3 years ago)
- Last Synced: 2024-03-13T07:21:42.721Z (4 months ago)
- Topics: fake-data, faker, mock, mock-data, mocker
- Language: TypeScript
- Homepage:
- Size: 9.77 KB
- Stars: 21
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Lists
- awesome-github-star - miz
README
# miz
> (< 800b) Generate fake / mock structured variable in a modern, human-readable way. Just like a person.
>
> ็จไธไธช็ฐไปฃ็ใๅฏ่ฏป็ๆนๅผๆฅ็ๆ็จไบๆต่ฏ็ๅๆฐๆฎใ
[](https://www.npmjs.com/package/miz)
[](https://github.com/hustcc/miz/actions)
[](https://coveralls.io/github/hustcc/miz?branch=master)
[](https://www.npmjs.com/package/miz)
## Features
โก๏ธ Simple but highly perfection API
๐ฃ Tiny footprint (< 800b)
๐ Customize
๐ 3 types of bundles exposed: ESM, CJS and UMD
๐ฅ TypeScript Typings readily available
๐ธ Browser and NodeJs supported
๐ฏ End-to-end testing with GitHub Action
## Install
```bash
$ npm i --save miz
```
## Usage
```ts
import { M } from 'miz'; // ES6
const m = M.arrayOf(M.shape({
id: M.number(10000, 1000000), // id is between 10000 ~ 1000000.
name: M.string(6), // 6 length random string.
sex: M.bool(), // random true or false.
city: M.constant('hz'), // constant value.
work: M.oneOf(['QA', 'FED']) // random from array
}), 2); // list length is 2.
m.mock();
```
Then will get the mock variable like below:
```ts
[{
id: 757852,
name: 'mU7RTB',
sex: false,
city: 'hz',
work: 'FED'
}, {
id: 359987,
name: 'jWuKxX',
sex: true,
city: 'hz',
work: 'FED'
}]
```
## API & Mocker
You can assemble the variable structure arbitrarily by **using the mockers** below:
- **M.bool()**
```ts
M.bool().mock(); // true
```
- **M.number(min[, max = min, fixed = 0])**
```ts
M.number(1, 9, 2).mock(); // 4.71
```
- **M.string([len = 8])**
```ts
M.string(6).mock(); // `Qv_teE`
```
- **M.constant(value)**
```ts
M.constant('hello, hustcc.').mock(); // `hello, hustcc`
M.constant(null).mock(); // got null
```
- **M.oneOf(valueArray)**
```ts
M.oneOf(['hustcc', 'imcxl']).mock(); // hustcc
```
- **M.arrayOf(mocker[, min = 20, max = min])**
```ts
// got an array which contains string, and array length 10 ~ 20.
M.arrayOf(VT.string(4), 10, 20);.mock();
```
- **M.shape(mockerObject)**
```ts
// random value object.
M.shape({
name: M.string(10),
id: M.number(10000, 1000000),
sex: M.bool(),
city: 'hz',
}).mock();
```
- **M.apply(Function)**
```ts
// will got number generate by fucntion Math.random()
M.apply(() => Math.random()).mock();
```
> More `Mocker` needed, welcome to `send a pull request`, or put an issue to me.
## License
ISC@[hustcc](https://github.com/hustcc).