Interface: JsonSharedConstraints

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/JsonConstraintsBuilder.ts:17

Shared constraints for:

• json,
• jsonValue,

Remarks

Since 2.5.0

Properties

depthSize?

optional depthSize?: DepthSize

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/JsonConstraintsBuilder.ts:24

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

---

maxDepth?

optional maxDepth?: number

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/JsonConstraintsBuilder.ts:30

Maximal depth allowed

Default Value

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

Remarks

Since 2.5.0

---

noUnicodeString?

optional noUnicodeString?: boolean

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/JsonConstraintsBuilder.ts:37

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

---

stringUnit?

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

Defined in: packages/fast-check/src/arbitrary/_internals/helpers/JsonConstraintsBuilder.ts:43

Replace the default unit for strings.

Default Value

undefined

Remarks

Since 3.23.0