fast-check/lib/types/arbitrary/_internals/helpers/JsonConstraintsBuilder.d.ts

Property based testing framework for JavaScript (like QuickCheck)

import type { StringConstraints } from '../../string.js';
import type { DepthSize } from './MaxLengthFromMinLength.js';
/**
 * Shared constraints for:
 * - {@link json},
 * - {@link jsonValue},
 *
 * @remarks Since 2.5.0
 * @public
 */
export interface JsonSharedConstraints {
    /**
     * Limit the depth of the object by increasing the probability to generate simple values (defined via values)
     * as we go deeper in the object.
     *
     * @remarks Since 2.20.0
     */
    depthSize?: DepthSize;
    /**
     * Maximal depth allowed
     * @defaultValue Number.POSITIVE_INFINITY — _defaulting seen as "max non specified" when `defaultSizeToMaxWhenMaxSpecified=true`_
     * @remarks Since 2.5.0
     */
    maxDepth?: number;
    /**
     * Only generate instances having keys and values made of ascii strings (when true)
     * @deprecated Prefer using `stringUnit` to customize the kind of strings that will be generated by default.
     * @defaultValue true
     * @remarks Since 3.19.0
     */
    noUnicodeString?: boolean;
    /**
     * Replace the default unit for strings.
     * @defaultValue undefined
     * @remarks Since 3.23.0
     */
    stringUnit?: StringConstraints['unit'];
}
/**
 * Typings for a Json array
 * @remarks Since 2.20.0
 * @public
 */
export type JsonArray = Array<JsonValue>;
/**
 * Typings for a Json object
 * @remarks Since 2.20.0
 * @public
 */
export type JsonObject = {
    [key in string]?: JsonValue;
};
/**
 * Typings for a Json value
 * @remarks Since 2.20.0
 * @public
 */
export type JsonValue = boolean | number | string | null | JsonArray | JsonObject;