Interface JsonSharedConstraints

Shared constraints for:

Remarks

Since 2.5.0

interface JsonSharedConstraints {
    depthSize?: DepthSize;
    maxDepth?: number;
    noUnicodeString?: boolean;
    stringUnit?:
        | Arbitrary<string>
        | "grapheme"
        | "binary"
        | "grapheme-composite"
        | "grapheme-ascii"
        | "binary-ascii";
}

Properties

depthSize? maxDepth? noUnicodeString? stringUnit?

Properties

OptionaldepthSize

depthSize?: DepthSize

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

OptionalmaxDepth

maxDepth?: number

Maximal depth allowed

Default Value

Number.POSITIVE_INFINITY — defaulting seen as "max non specified" when defaultSizeToMaxWhenMaxSpecified=true

Remarks

Since 2.5.0

OptionalnoUnicodeString

noUnicodeString?: boolean

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.

Default Value

true

Remarks

Since 3.19.0

OptionalstringUnit

stringUnit?:
    | Arbitrary<string>
    | "grapheme"
    | "binary"
    | "grapheme-composite"
    | "grapheme-ascii"
    | "binary-ascii"

Replace the default unit for strings.

Default Value

undefined

Remarks

Since 3.23.0

Settings

Member Visibility

On This Page

Properties