# tseudo

> Modern performant pseudo random data generator

Latest version **0.0.7** (published 2023-01-29) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install tseudo
pnpm add tseudo
yarn add tseudo
bun add tseudo
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2023-01-29 |
| First published | 2023-01-03 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 742.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nicholas Mordecai |
| Maintainers | megmut |
| Keywords | random, pseudo, fake, data, testing |

## Links

- npm: https://www.npmjs.com/package/tseudo
- npm.io page: https://npm.io/package/tseudo

## Dependencies (4)

- [md5](https://npm.io/package/md5.md) ^2.3.0
- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [typescript](https://npm.io/package/typescript.md) ^4.8.3
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^9.0.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.0.7 (latest) — 2023-01-29
- 0.0.6 — 2023-01-15
- 0.0.5 — 2023-01-11
- 0.0.4 — 2023-01-06
- 0.0.3 — 2023-01-05
- 0.0.2 — 2023-01-03

## README

[![<typescript>](https://badgen.net/badge/typescript/strict%20%F0%9F%92%AA/blue?icon=typescript)](https://www.typescriptlang.org/)
[![<megmut>](https://github.com/megmut/tseudo/actions/workflows/test.yaml/badge.svg)](https://github.com/megmut/tseudo/actions/workflows/test.yaml)
[![<megmut>](https://github.com/megmut/tseudo/actions/workflows/build.yaml/badge.svg)](https://github.com/megmut/tseudo/actions/workflows/build.yaml)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![npm](https://img.shields.io/npm/v/tseudo?style=flat-square)
[![Coverage Status](https://coveralls.io/repos/github/megmut/tseudo/badge.svg?branch=main)](https://coveralls.io/github/megmut/tseudo?branch=main)

# tseudo

## Modern performant pseudo random data generator

> Please note, this is still very early development and has not been tested in a production envirnoment!

## Installing
```sh 
$ npm i tseudo
# or
$ yarn add tseudo
```

## Examples
### Using Generators

Generators are individual functions that return pseudo random data.

Example 1: Create a random address
```ts
import { address } from 'tseudo';
const address = address();

/*
	{
	  country: 'United Kingdom',
	  county: 'Devon',
	  city: 'Birmingham',
	  street: 'Green Lane',
	  houseNumber: 'Red Stables',
	  postcode: 'VX53 8ZF'
	}
*/
```

For a full break down of all generators, click here.

### Using Registers
Registers are kind of like factories. You can describe your object with built in, custom or inline functions to be group generators together for ease of use.

Example 1: 
```ts
import { Register, address, rngInt } from  '../core/register';

const  user  = {
	address: address,
	age: () =>  rngInt({min: 18, max: 80})
};

const userRegister = new Register(user);
```
In order to generate a new user, you can call the `build` method on that register.
Example 2a:
```ts
...
const newUser = userRegister.build();

/*
{
  address: {
    country: 'United Kingdom',
    county: 'Essex',
    city: 'Bristol',
    street: 'Kings Lane',
    houseNumber: 7,
    postcode: 'ET9 6WS'
  },
  age: 25
}
*/
```

### Server
If you're developing on the frontend, or are performing API integrations then you may find it very useful to couple registers up with an API. It's a fast and east way to generate data and fetch it through a restful API.

Example 3.

```ts
import { Server } from 'tseudo';

const server = new Server();

// create registers
const userRegister = new Register(user);
const account = new Register(account);

// define routes
const routes = {
    '/user': userRegister,
	'/cart': cartRegister
};

server.run(routes);
```

## Core Generators

#### Math 

| Name | Description | Type |
|--|--|--|
| rngInt | random integer | number |
| rngfloat | random floating point | number |
| normalDist | random float with a normal distribution | number |
| percent | random float between 0 and 1 | number |
| percentString | percent but as a string eg: '45%' | string |

#### String Util
| Name | Description | Type |
|--|--|--|
| fromFormat | random string from format (ZZ99-99) | string |

#### Array Util
| Name | Description | Type |
|--|--|--|
| rngFromArray | pick a random element from an array | elementType |

#### Geographic
| Name | Description | Type |
|--|--|--|
| postcode | postcode or zipcode | string |
| city | the city | string |
| county | the county | string |
| street | the street | string |
| houseNameNumber | the house name or number | string |
| address | full address in object format | IAddress |
| addressString | full address represented as a string | string |


## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
  
1. Fork it!
2. Create your feature branch: `git checkout -b feat/my-new-feature`
3. Add your changes: `git add .`
4. Commit your changes: `git commit -m 'Add some feature'`
5. Push to the branch: `git push origin my-new-feature`
6. Submit a pull request :sunglasses:

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/megmut/tseudo/tags).

## Authors

-  **Nicholas Mordecai**

See also the list of [contributors](https://github.com/megmut/tseudo/contributors) who participated in this project.

## License

[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0) © Nicholas Mordecai

=======

##### Notes To Self

- If a nested structure is optional, a config should be set to allow that nested property to be or not to be generated

### Need to write -

1. an object can lookup the values of a parent object for conditional statements / branches
2. you should be able to wrap any fn in a probability factor to determine one of multiple outcomes
3. Override any value / property from a function generator

---
_Source: https://npm.io/package/tseudo · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._