isValidX12DateRange

Unreleased

Not in @northguild/gmt 1.18.0 on npm yet. It is on main and ships in the next release.

Signature

isValidX12DateRange(value: string, format: X12DateRangeFormat): boolean

Return true when value is an X12 Date Time Period value (data element 1251) that states a range between two real calendar dates, in a date range format qualifier (data element 1250).

• Format codes

  Code	Mask	The dictionary’s definition
  RD8	CCYYMMDD-CCYYMMDD	“Range of Dates Expressed in Format CCYYMMDD-CCYYMMDD”
  RD	MMDDCCYY-MMDDCCYY	“Range of Dates Expressed in Format MMDDCCYY-MMDDCCYY”

• True exactly when parseX12DateRange returns a range for the same arguments: the validator calls the parser, so the two cannot disagree.

• A range is valid with exactly one hyphen: "2024061520240620" is false.

• A range whose end precedes its start is false; an end equal to its start is true.

• Checks the calendar as well as the shape: 29 February 2023 in either date is false.

• False for any other code, a code of another kind included; check a code alone with isValidX12DateTimePeriodFormat. False for a non-string argument.

Parameters

Parameter	Type	Description
value	string	The data element 1251 value (e.g. “20240615-20240620”)
format	X12DateRangeFormat	X12 data element 1250 format qualifier

Returns

boolean indicating validity

Related types

• X12DateRangeFormat

Examples

import { isValidX12DateRange } from "@northguild/gmt/intermodal/validate";

isValidX12DateRange("20240615-20240620", "RD8") // true

value

output

 

Source

intermodal/validate/isValidX12DateRange.ts