Function: combinator()

WARNING

This API is experimental and may change in future versions.

Create a custom argument schema with a user-defined parse function.

This is the most general custom combinator. Use it when none of the built-in base combinators (string, number, integer, float, boolean, choice) fit your needs.

The returned schema has type: 'custom'.

Signature

declare function combinator<T>(config: CombinatorOptions<T>): CombinatorSchema<T>

Type Parameters

Name	Description
T	The parsed value type.

Parameters

Name	Type	Description
config	CombinatorOptions<T>	Configuration with a parse function and optional metavar.

Returns

CombinatorSchema<T> — A combinator schema that resolves to the parse function's return type.

Examples

const date = combinator({
  parse: (value) => {
    const d = new Date(value)
    if (isNaN(d.getTime())) {
      throw new Error('Invalid date format')
    }
    return d
  },
  metavar: 'date'
})