Installation

npm install --save @types/json-schema-faker

Summary

This package contains type definitions for json-schema-faker (https://github.com/json-schema-faker/json-schema-faker).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/json-schema-faker.

index.d.ts

1import { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
2
3declare namespace jsf {
4    const version: string;
5    function format(nameOrFormatMap?: NameOrFormatMap, callback?: (schema?: Schema) => void): any;
6    function extend(name: string, cb: () => void): any;
7    function define(name: string, cb: () => void): any;
8    function reset(name: string): any;
9    function locate(name: string): any;
10    function generate(schema: Schema, refs?: string | Schema[]): any;
11    function resolve(schema: Schema, refs?: string | Schema[], cwd?: string): Promise<any[]>;
12    function option(option: string | OptionInputObject, value?: any): any;
13
14    // jsf.random
15    namespace random {
16        function randexp(value: string): string | number;
17        function pick<T>(collection: T[]): T;
18        function date(step: string): Date;
19        function shuffle<T>(collection: T[]): T[];
20        function number(min?: number, max?: number, defMin?: number, defMax?: number, hasPrecision?: boolean): number;
21    }
22
23    type Schema = JSONSchema4 | JSONSchema6 | JSONSchema7;
24    type OptionInputObject = Partial<
25        {
26            [option in jsfOptions]: any;
27        }
28    >;
29    type NameOrFormatMap = string | { name: string; callback: (schema?: Schema) => void };
30
31    // List of all valid registerable options.
32    type jsfOptions =
33        | "defaultInvalidTypeProduct"
34        | "defaultRandExpMax"
35        | "ignoreProperties"
36        | "ignoreMissingRefs"
37        | "failOnInvalidTypes"
38        | "failOnInvalidFormat"
39        | "alwaysFakeOptionals"
40        | "optionalsProbability"
41        | "fixedProbabilities"
42        | "useExamplesValue"
43        | "useDefaultValue"
44        | "requiredOnly"
45        | "minItems"
46        | "maxItems"
47        | "minLength"
48        | "maxLength"
49        | "refDepthMin"
50        | "refDepthMax"
51        | "resolveJsonPath"
52        | "reuseProperties"
53        | "fillProperties"
54        | "random"
55        | "replaceEmptyByRandomValue";
56}
57
58/** @deprecated calling JsonSchemaFaker() is deprecated, call either .generate() or .resolve()' */
59declare function jsf(schema: jsf.Schema, refs?: string | jsf.Schema[]): any;
60export as namespace jsf;
61export = jsf;
62

Additional Details

• Last updated: Tue, 07 Nov 2023 03:09:37 GMT
• Dependencies: @types/json-schema

Credits

These definitions were written by Charles Desbiens.