# fictum

> fictum lib

Latest version **0.0.8** (published 2022-04-16) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2022-04-16 |
| First published | 2022-04-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 14.18.3 |
| Dependencies | 0 |
| Unpacked size | 21.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | leal32b |
| Maintainers | leal32b |
| Keywords | fictum, fake, faker, data, generator, test, mock, fixtures, random |

## Links

- npm: https://www.npmjs.com/package/fictum
- Repository: https://github.com/leal32b/fictum
- Homepage: https://github.com/leal32b/fictum#readme
- Issues: https://github.com/leal32b/fictum/issues
- npm.io page: https://npm.io/package/fictum

## 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
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2022-04-16
- 0.0.7 — 2022-04-16
- 0.0.6 — 2022-04-15
- 0.0.5 — 2022-04-14
- 0.0.4 — 2022-04-14
- 0.0.3 — 2022-04-14
- 0.0.2 — 2022-04-11
- 0.0.1 — 2022-04-10

## README

# Fictum
Fictum is a fake data generator designed to aid (in a simple and dynamic way) testing.

![image](https://img.shields.io/github/license/leal32b/fictum?style=flat-square)
![image](https://img.shields.io/npm/v/fictum?style=flat-square)
![image](https://img.shields.io/npm/dw/fictum?style=flat-square)
![image](https://img.shields.io/codecov/c/gh/leal32b/fictum?style=flat-square)
![image](https://img.shields.io/circleci/build/github/leal32b/fictum/main?style=flat-square)
![image](https://img.shields.io/github/issues/leal32b/fictum?style=flat-square)
## Installation
```bash
npm install fictum
```

## Usage

```javascript
// javascript
const fictum = require('fictum')
```

```typescript
// typescript
import fictum from 'fictum'
```

```typescript
// You can set a locale as ISO Language Code
// If not set, the default locale is 'en'
fictum.locale('pt-BR')

// Generate a random first name
const name = fictum.person.firstName()

// Apply filters
const fixedGenderName = fictum.person.firstName({ gender: 'f' })
```

## Components

```typescript
// Person

fictum.person.firstName()                                  // 'Steven'
fictum.person.firstName({ gender: 'f' })                   // 'Ashley'
fictum.person.lastName()                                   // 'Smith'
fictum.person.fullName()                                   // 'Linda Brown'
fictum.person.fullName({ gender: 'm' })                    // 'Charles Williams'
fictum.person.fullName({ format: 'lastName, firstName' })  // 'Jackson, Paul'
```

## License
MIT

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