---

📦 Installation

bash
1npm install --save-dev valimock @faker-js/faker

bash
1yarn add -D valimock @faker-js/faker

🔧 Usage

Import and optionally configure a new instance of the Valimock class, then pass along your valibot schema to mock(), that's it!

ts
1import { parse, array, union, string, pipe, url, number, maxValue } from "valibot";
2import { Valimock } from "valimock";
3
4describe(`example test`, () => {
5  it(`should generate valid mock data`, () => {
6    const schema = array(union([pipe(string(), url()), pipe(number(), maxValue(20))]));
7    const result = new Valimock().mock(schema);
8    expect(parse(schema, result)).toStrictEqual(result);
9  });
10});

[!NOTE]

For async schemas, you will need to use parseAsync(). Be aware that async schemas generate a Promise and may need to be await'ed depending on usage.

Please see the __tests__ folder for more usage examples of different schema types.

API Coverage

[!WARNING]

At present, not all of valibot's API is fully covered by valimock, however, any unimplemented schema type can be handled by a user-supplied map via the customMocks configuration option. The schema's type proerty is used as the property key for this map.

Schemas

Validations

Below is an incomplete list of supported validations for the given schemas.

Array

BigInt

Date

Number

String

📣 Acknowledgements

Valimock's implementation is based on @anatine/zod-mock

🥂 License

Released under the MIT license © Drake Costa.