Interface OptionConstraints<TNil>

Constraints to be applied on option

Remarks

Since 2.2.0

interface OptionConstraints<TNil = null> {
    depthIdentifier?: string | DepthIdentifier;
    depthSize?: DepthSize;
    freq?: number;
    maxDepth?: number;
    nil?: TNil;
}

Type Parameters

  • TNil = null

Properties

depthIdentifier? depthSize? freq? maxDepth? nil?

Properties

OptionaldepthIdentifier

depthIdentifier?: string | DepthIdentifier

Depth identifier can be used to share the current depth between several instances.

By default, if not specified, each instance of option will have its own depth. In other words: you can have depth=1 in one while you have depth=100 in another one.

Remarks

Since 2.14.0

OptionaldepthSize

depthSize?: DepthSize

While going deeper and deeper within a recursive structure (see letrec), this factor will be used to increase the probability to generate nil.

Remarks

Since 2.14.0

Optionalfreq

freq?: number

The probability to build a nil value is of 1 / freq

Default Value

5

Remarks

Since 1.17.0

OptionalmaxDepth

maxDepth?: number

Maximal authorized depth. Once this depth has been reached only nil will be used.

Default Value

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

Remarks

Since 2.14.0

Optionalnil

nil?: TNil

The nil value

Default Value

null

Remarks

Since 1.17.0

Settings

Member Visibility

On This Page

Properties