Namespace SchemaGenerator

`arkTest.SchemaGenerator`

A random seed generator that can be interpreted to produce an arbitrary ArkType schema.

The generator supports a wide range of configuration options that are discoverable via the optional options argument.

Many of those options are forwarded to the corresponding fast-check arbitrary.

Note: support for options.minDepth is experimental. If you use it, be advised that even with a minimum depth of 1, the schemas produced will be quite large. Using this option in your CI/CD pipeline is not recommended.

Example

import * as fc from 'fast-check'
import { type } from 'arktype'
import { arkTest } from '@traversable/arktype-test'

const tenSchemas = fc.sample(arkTest.SchemaGenerator({
  include: ['null', 'boolean', 'number', 'string', 'array', 'object'] 
}), 10)

Type Aliases

Options

Namespace SchemaGenerator

`arkTest.SchemaGenerator`

Example

Type Aliases

Settings

On This Page