dateCursor

function dateCursor(valueIso: string, options?: {
  inclusive?: boolean;
}): {
  inclusive?: true;
  type: "date";
  value: string;
};

Build a typed date cursor from an ISO-8601 string.

Parameters

Parameter	Type	Description
valueIso	string	The boundary date this run reached.
options	{ inclusive?: boolean; }	Set inclusive when the boundary item itself must be re-emitted next run (a >= comparison) rather than skipped (the default strict >). Feeds whose timestamps have second granularity need it, or items sharing the boundary second are lost.
options.inclusive?	boolean	-

Returns

{
  inclusive?: true;
  type: "date";
  value: string;
}

The cursor to return from sync. inclusive is omitted rather than written as false, because the stored bytes are a contract and a reader distinguishes absent from present.

Name	Type
inclusive?	true
type	"date"
value	string