Skip to the content.

Variable: ValidationErrorFactory

const ValidationErrorFactory: {
  invalidEmail: (email: string) => InvalidFieldValueError;
  invalidFQDN: (domain: string) => InvalidFieldValueError;
  invalidHexString: (value: string) => InvalidFieldValueError;
  invalidIPAddress: (address: string, version: 4 | 6) => InvalidFieldValueError;
  invalidPort: (port: number) => InvalidFieldValueError;
  invalidPriority: (priority: number) => InvalidFieldValueError;
  invalidRecordType: (type: unknown) => InvalidRecordTypeError;
  invalidTTL: (ttl: number) => InvalidFieldValueError;
  invalidWeight: (weight: number) => InvalidFieldValueError;
  malformedRecord: (message: string) => MalformedRecordError;
  missingRequiredField: (
    field: string,
    recordType: string,
  ) => MissingRequiredFieldError;
};

Defined in: src/errors.ts:251

Factory functions for creating validation errors with consistent messaging

Type Declaration

invalidEmail

readonly invalidEmail: (email: string) => InvalidFieldValueError;

Parameters

email

string

Returns

InvalidFieldValueError

invalidFQDN

readonly invalidFQDN: (domain: string) => InvalidFieldValueError;

Parameters

domain

string

Returns

InvalidFieldValueError

invalidHexString

readonly invalidHexString: (value: string) => InvalidFieldValueError;

Parameters

value

string

Returns

InvalidFieldValueError

invalidIPAddress

readonly invalidIPAddress: (address: string, version: 4 | 6) => InvalidFieldValueError;

Parameters

address

string

version
4 6

Returns

InvalidFieldValueError

invalidPort

readonly invalidPort: (port: number) => InvalidFieldValueError;

Parameters

port

number

Returns

InvalidFieldValueError

invalidPriority

readonly invalidPriority: (priority: number) => InvalidFieldValueError;

Parameters

priority

number

Returns

InvalidFieldValueError

invalidRecordType

readonly invalidRecordType: (type: unknown) => InvalidRecordTypeError;

Parameters

type

unknown

Returns

InvalidRecordTypeError

invalidTTL

readonly invalidTTL: (ttl: number) => InvalidFieldValueError;

Parameters

ttl

number

Returns

InvalidFieldValueError

invalidWeight

readonly invalidWeight: (weight: number) => InvalidFieldValueError;

Parameters

weight

number

Returns

InvalidFieldValueError

malformedRecord

readonly malformedRecord: (message: string) => MalformedRecordError;

Parameters

message

string

Returns

MalformedRecordError

missingRequiredField

readonly missingRequiredField: (field: string, recordType: string) => MissingRequiredFieldError;

Parameters

field

string

recordType

string

Returns

MissingRequiredFieldError