Variable rulesConst

Type Declaration

• bankCode: () => ValidatorRule<BankInfo>

  A CBSL bank code. Parsed value: BankInfo.

• contactPhone: () => ValidatorRule<PhoneInfo>

  A full phone number; rejects short codes.

• currency: (opts?: LkrValidationOptions) => ValidatorRule<number>

  Valid LKR amount within the given range. Parsed value: the amount as a number.

• dob: (
      opts?: DobOptions,
  ) => ValidatorRule<{ age: number; dob: Date; isoDate: string }>

  Valid date of birth within the given age range.

• drivingLicense: () => ValidatorRule<DrivingLicenseInfo>

  Valid driving licence number.

• gender: () => ValidatorRule<Gender>

  Recognised gender value. Parsed value: male or female.

• matchesNicDob: (nicFieldName?: string) => ValidatorRule<unknown>

  Fails when the date of birth does not match the NIC in nicFieldName. Passes when either value is missing.

• matchesNicGender: (nicFieldName?: string) => ValidatorRule<unknown>

  Fails when the gender does not match the NIC in nicFieldName. Passes when either value is missing.

• mobile: () => ValidatorRule<PhoneInfo>

  A mobile number only.

• nic: (opts?: NicOptions) => ValidatorRule<NicInfo>

  Valid NIC. Parsed value: NicInfo.

• nullable: <T>(rule: ValidatorRule<T>) => ValidatorRule<T | null>

  Passes null; otherwise applies rule.

• optional: <T>(rule: ValidatorRule<T>) => ValidatorRule<T | undefined>

  Passes undefined and empty strings; otherwise applies rule.

• passport: () => ValidatorRule<PassportInfo>

  Valid passport number. Parsed value: PassportInfo.

• phone: () => ValidatorRule<PhoneInfo>

  Any valid phone number, including short codes. Parsed value: PhoneInfo.

• postalCode: () => ValidatorRule<PostalCodeInfo>

  Valid postal code with a known prefix.

• required: (message?: string) => ValidatorRule<unknown>

  Fails with code REQUIRED when the value is undefined, null, or a blank string.

• tin: () => ValidatorRule<string>

  TIN format (9 or 10 digits).

• vat: () => ValidatorRule<string>

  VAT registration number format.

• vehiclePlate: () => ValidatorRule<VehiclePlateInfo>

  Valid vehicle registration plate.