Skip to content

mniebling/light-fakery

Repository files navigation

light-fakery

A lightweight library for generating fake data in JS/TS.

Documentation

Its guiding principles are:

  • Structured as a pure ESM package
  • Tree-shakable so you only bundle data you are using
  • First class support for consuming the library in TypeScript
  • Focused on fake data use cases that make sense in a business-y environment
  • Easy to extend if you need additional data
  • Zero dependencies

Development

npm run build — Compile Typescript and emit to ./dist.

npm test — Run unit tests on the compiled output.

npm run release — Kick off an NPM release. You'll be prompted for the release details and the command will run a build before releasing. This will also attempt to perform a GitHub release, so you will need to have appropriate permissions there to update the details.