Skip to content

@pcvl/schema / CheckOptions

Type Alias: CheckOptions ​

ts
type CheckOptions = IssueEditableProps;

Defined in: types.ts:51

The options a check takes as its last argument, a Constraint, a Refinement or object's .strict(): what of the Issue it reports to edit, a custom message replacing the check's default.

Example ​

ts
import { pvl, type CheckOptions } from '@pcvl/schema';

const options: CheckOptions = { message: 'must be at least 3 characters' };
pvl.string().min(3, options);