LogoRobo.js
Packages@robojs/roadmap

getCardsFromDateRange()

Function: getCardsFromDateRange()

function getCardsFromDateRange(
   provider, 
   startDate, 
   endDate, 
dateField): Promise<readonly RoadmapCard[]>

Fetches cards within a custom date range.

Parameters

ParameterTypeDefault valueDescription
providerRoadmapProvider<ProviderConfig>undefinedThe roadmap provider instance.
startDatestring | DateundefinedStart date (Date object or ISO 8601 string).
endDatestring | DateundefinedEnd date (Date object or ISO 8601 string).
dateFieldundefined | "created" | "updated"'updated'The date field to filter on (defaults to 'updated').

Returns

Promise<readonly RoadmapCard[]>

Array of cards within the date range.

Throws

Error if dates are invalid, start > end, provider is null/undefined, or provider doesn't support date filtering.

Example

const cards = await getCardsFromDateRange(provider, '2025-01-01', '2025-01-31');

On this page