A small npm package that helps generate some random data, ie emails, plain text, passwords, usernames and the list goes on.

Installation

npm i give-me-data --save

Usage

Secure Passwords

The example below show you how to generate secure passwords, the props table below shows you how to manipulate the output value of the function. You can generate long passwords with different casing, symbols enabled or aplhanumeric combinations.

| props | type | defaults | description | | -------------------- | ------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | output | string | single | By default output is set to a single randomly password. Other variations of values that can be provided are as follows list or single | | outputLength | number | 0 | This prop allows you to return x number of random passwords inside an array. by default this property doesnt really do anything unless list was set for the output | | length | number | 20 | This is a number value this can be set to what ever valiue you would like to determine the length of the outputted password. | | contains | shape | { lowercase: true, numbers: true } | By default passwords contain lowercase and numbers you can add more options to this object by using the props below | | contains > uppercase | bool | false | If this prop is set to true then the password has the ability of containing uppercase chars | | contains > lowercase | bool | true | If this prop is set to true then the password has the ability of containing lowercase chars | | contains > numbers | bool | true | If this prop is set to true then the password has the ability of containing numbers chars | | contains > specials | bool | false | If this prop is set to true then the password has the ability of containing specials chars |

import { passwordGenerator } from 'give-me-data';

passwordGenerator({
  output: 'list | single',
  outputLength: 0,
  passwordLength: 50
  contains: {
    uppercase: true,
    lowercase: true,
    specials: true,
    numbers: true
  }
});

| Introduced | Updated | | ---------- | ---------- | | 12/07/2020 | 13/07/2020 |

Random UserNames

| props | type | defaults | description | | ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | separator | string | `` | This prop defaults to an empty dtring meaning there will be no separator between any of the words. You can pass one of the following as separators | | numberOfUsernames | number | 10 | This prop allows you to request as many random usernames as you want. This will always be returned in a list. | | maxNumberOfWords | number | 1 | This prop allows you to request the number of seperated words that are returned in a single string if the value of this proiperty is set to 1. If set higher than one an array of usewrnames are generated and returned. This value must be greater than or equal to 1. |

import { usernameGenerator } from 'give-me-data';

usernameGenerator({
  separator: '-',
  maxNumberOfWords: 1,
  numberOfUsernames: 20,
});

| Introduced | Updated | | ---------- | ---------- | | 13/07/2020 | 13/07/2020 |

Email Addresses - UNDER DEVELOPMET - Planned for v1.2.0

| props | defaults | description | | ----- | -------- | ----------- |

import { emailGenerator } from 'give-me-data';

emailGenerator();

| Introduced | Updated | | ---------- | ------- | | TBC | TBC |

Plain Text - UNDER DEVELOPMET - Planned for v1.3.0

| props | defaults | description | | ----- | -------- | ----------- |

import { textGenerator } from 'give-me-data';

textGenerator();

| Introduced | Updated | | ---------- | ------- | | TBC | TBC |

Populate Model - UNDER DEVELOPMET - Planned for v1.4.0

| props | defaults | description | | ----- | -------- | ----------- |

import { populateModel } from 'give-me-data';

populateModel();

| Introduced | Updated | | ---------- | ------- | | TBC | TBC |