fake
所属分类:工具库
开发工具:TypeScript
文件大小:0KB
下载次数:0
上传日期:2021-08-18 16:07:36
上 传 者:
sh-1993
说明: 假数据发生器
(Fake data generator)
文件列表:
.babelrc (169, 2021-08-18)
.npmignore (42, 2021-08-18)
package-lock.json (649218, 2021-08-18)
package.json (1119, 2021-08-18)
src/ (0, 2021-08-18)
src/index.ts (7652, 2021-08-18)
test/ (0, 2021-08-18)
test/Fake.test.ts (1876, 2021-08-18)
tsconfig.json (671, 2021-08-18)
# @wbe/fake
Generate fake data image/text/video allowing to test UI components
![](https://img.shields.io/npm/v/@wbe/fake/latest.svg)
![](https://img.shields.io/bundlephobia/minzip/@wbe/fake.svg)
![](https://img.shields.io/david/willybrauner/libraries.svg?path=packages%2Futils%2Ffake)
![](https://img.shields.io/npm/dt/@wbe/fake.svg)
![](https://img.shields.io/npm/l/@wbe/fake.svg)
## Installation
```shell script
$ npm install -s @wbe/fake
```
## How to use
Import `Fake`:
```tsx
import Fake from "@wbe/fake";
```
## API
- [responsiveImageData](#responsiveImageData)
- [videoUrl](#videoUrl)
- [videoId](#videoId)
- [title](#title)
- [text](#text)
###
responsiveImageData
Get an array of random IFakeImage objects.
```tsx
responsiveImageData(pRatio, pBreakpoints);
```
#### Parameters
- `pRatio (number)`: Image ratio - default: `4 / 3`
- `pBreakpoints (number[])`: Breakpoints list - default: `[640, 1024, 1440, 1920]`
#### Returns
`(Array) IFakeImage[]`: Array of IFakeImage data object
#### Example
```tsx
// will returned an array of IFakeImage object with 16/9 ratio
const responsiveImageData = Fake.responsiveImageData(16 / 9);
```
###
videoUrl
Get a random video URL.
```tsx
videoUrl(pFakeVideoType, pYoutubeId, pVimeoId);
```
#### Parameters
- `pFakeVideoType (EVideoType
)`: Type of video
- `pYoutubeId (string)`: Specify youtube ID to use - default: random ID
- `pVimeoId (string)`: Specify vimeo ID to use - default: random ID
#### Returns
`(string)`: video URL
#### Example
```tsx
// will returned a random youtube url
const youtubeUrl = Fake.videoUrl(EVideoType.YOUTUBE);
```
### videoId
Get a random video ID.
```tsx
videoId(pFakeVideoType);
```
#### Parameters
- `pFakeVideoType (EVideoType)`: Type of video
#### Returns
`(string)`: video ID
#### Example
```tsx
// will returned a random vimeo id
const vimeoUrl = Fake.videoId(EVideoType.VIMEO);
```
### title
Get a random title.
```tsx
title(pWords);
```
#### Parameters
- `pWords (number)`: Number of words - default: `1`
#### Returns
`(string)`: title
#### Example
```tsx
// will returned two random words
const title = Fake.title(2);
```
### text
Get random text.
```tsx
text(pSentencies);
```
#### Parameters
- `pSentencies (number)`: Number of sentencies - default: `1`
#### Returns
`(string)`: text
#### Example
```tsx
// will returned four random sentencies
const text = Fake.text(4);
```
近期下载者:
相关文件:
收藏者: