@wbe/fake-data-utils
TypeScript icon, indicating that this package has built-in type declarations

2.3.0 • Public • Published

@wbe/fake-data-utils

Generate fake data image/text/video allowing to test UI components

Installation

$ npm install -s @wbe/fake-data-utils

How to use

Import fakeDataUtils:

import { fakeDataUtils } from "@wbe/fake-data-utils";

API

getResponsiveImageData

Get an array of random IFakeImage objects.

getResponsiveImageData(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

// will returned an array of IFakeImage object with 16/9 ratio
const responsiveImageData = FakeDataUtils.getResponsiveImageData(16 / 9);

getVideoUrl

Get a random video URL.

getVideoUrl(pFakeVideoType, pYoutubeId, pVimeoId);

Parameters

  • pFakeVideoType (EVideoType<YOUTUBE|VIMEO|NATIVE>): 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

// will returned a random youtube url
const youtubeUrl = FakeDataUtils.getVideoUrl(EVideoType.YOUTUBE);

getVideoId

Get a random video ID.

getVideoId(pFakeVideoType);

Parameters

  • pFakeVideoType (EVideoType<YOUTUBE|VIMEO>): Type of video

Returns

(string): video ID

Example

// will returned a random vimeo id
const vimeoUrl = FakeDataUtils.getVideoId(EVideoType.VIMEO);

getTitle

Get a random title.

getTitle(pWords);

Parameters

  • pWords (number): Number of words - default: 1

Returns

(string): title

Example

// will returned two random words
const title = FakeDataUtils.getTitle(2);

getText

Get random text.

getText(pSentencies);

Parameters

  • pSentencies (number): Number of sentencies - default: 1

Returns

(string): text

Example

// will returned four random sentencies
const text = FakeDataUtils.getText(4);

Readme

Keywords

Package Sidebar

Install

npm i @wbe/fake-data-utils

Weekly Downloads

0

Version

2.3.0

License

MIT

Unpacked Size

76 kB

Total Files

16

Last publish

Collaborators

  • willybe