formatX12DateRange

Unreleased

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

Signature

formatX12DateRange(start: string, end: string, format: X12DateRangeFormat): string

Write two ISO 8601 dates as an X12 Date Time Period range (data element 1251) in a date range format qualifier (data element 1250). The inverse of parseX12DateRange.

• Codes are release 005010, read from Stedi’s X12-licensed dictionary; the X12 text itself was not reached. ### 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”

• start and end are dates, as isValidDate accepts them: the two members parseX12DateRange returns. A date-time, an instant or a time returns "".

• The range is written with the one hyphen X12 transmits: 15 to 20 June 2024 is 20240615-20240620 under RD8.

• An end before its start returns "": a reversed range names no span of time. An end equal to its start is written.

• A year outside 0000–9999 in either date returns "".

• Returns "" for any other code, a code of another kind included, and for a non-string argument.

Parameters

Parameter	Type	Description
start	string	ISO 8601 date the range starts on (e.g. “2024-06-15”)
end	string	ISO 8601 date the range ends on (e.g. “2024-06-20”)
format	X12DateRangeFormat	X12 data element 1250 format qualifier

Returns

the data element 1251 value, or "" on invalid input

Related types

• X12DateRangeFormat

Examples

import { formatX12DateRange } from "@northguild/gmt/intermodal/format";

formatX12DateRange("2024-06-15", "2024-06-20", "RD8") // "20240615-20240620"

startend

output

 

Source

intermodal/format/formatX12DateRange.ts