@pcvl/schema / ISSUE_CODE

Variable: ISSUE_CODE

const ISSUE_CODE: object;

Defined in: issue/enums.ts:19

Every code an Issue can carry. Match on these rather than on message, which is prose and can be replaced per call site with a custom { message } option.

Type Declaration

CUSTOM

readonly CUSTOM: "CUSTOM" = 'CUSTOM';

INVALID_LENGTH

readonly INVALID_LENGTH: "INVALID_LENGTH" = 'INVALID_LENGTH';

INVALID_TYPE

readonly INVALID_TYPE: "INVALID_TYPE" = 'INVALID_TYPE';

INVALID_UNION

readonly INVALID_UNION: "INVALID_UNION" = 'INVALID_UNION';

INVALID_VALUE

readonly INVALID_VALUE: "INVALID_VALUE" = 'INVALID_VALUE';

NOT_INTEGER

readonly NOT_INTEGER: "NOT_INTEGER" = 'NOT_INTEGER';

TOO_BIG

readonly TOO_BIG: "TOO_BIG" = 'TOO_BIG';

TOO_SMALL

readonly TOO_SMALL: "TOO_SMALL" = 'TOO_SMALL';

UNRECOGNIZED_KEY

readonly UNRECOGNIZED_KEY: "UNRECOGNIZED_KEY" = 'UNRECOGNIZED_KEY';

Example

import { ISSUE_CODE, pvl } from '@pcvl/schema';

const result = pvl.string().min(3).validate('hi');
if (result.issues) {
  result.issues[0]?.code === ISSUE_CODE.TOO_SMALL; // true
}