Class CronParser

Privateconstructor

• new CronParser(): CronParser

  Returns CronParser

Private Static Optionalinstance

Private Static ReadonlySPLIT

PrivatecomputeValues

• computeValues(
      components: ParsedFieldComponent[],
      fieldName: CronFieldName,
  ): Set<number>

  Compute and validate the full set of matching integers from parsed components.

  Parameters

  • components: ParsedFieldComponent[]
  • fieldName: CronFieldName

  Returns Set<number>

PrivateexpandAlias

• expandAlias(expr: string): string

  Expand a special alias into its 5-field equivalent.

  Parameters

  • expr: string

  Returns string

parse

• parse(expr: string): ParsedCronExpression

  Parse a cron expression into a fully validated internal representation.

  The returned object contains the parsed field definitions together with pre-computed value sets for efficient schedule evaluation.

  Parameters

  • expr: string

    A standard 5-field cron string or special alias.

  Returns ParsedCronExpression

  A fully parsed cron expression.

  Throws

  Error if the expression is malformed or contains invalid values.

  Example

  const parsed = parser.parse( '* 9-17 * JAN,MAR MON-FRI' );
  Copy

PrivateparseFieldToken

• parseFieldToken(token: string, fieldName: CronFieldName): ParsedFieldComponent[]

  Parse a single field token into components.

  Parameters

  • token: string
  • fieldName: CronFieldName

  Returns ParsedFieldComponent[]

PrivateresolveAlias

• resolveAlias(token: string, fieldName: CronFieldName): string | number

  Expand a named alias (e.g. JAN) to its numeric value for the given field.

  Parameters

  • token: string
  • fieldName: CronFieldName

  Returns string | number

PrivatesplitFields

• splitFields(expr: string): CronTuple

  Split a cron expression string into its five field tokens.

  Parameters

  • expr: string

  Returns CronTuple

toObject

• toObject(expr: string): CronObject

  Convert a cron expression into a structured CronObject.

  Parameters

  • expr: string

    A standard 5-field cron string or special alias.

  Returns CronObject

  A CronObject containing the raw field values.

  Throws

  Error if the expression is malformed.

  Example

  parser.toObject( '0 9 * * MON' );
  Copy

toTuple

• toTuple(expr: string): CronTuple

  Convert a cron expression into a ordered CronTuple.

  Parameters

  • expr: string

    A standard 5-field cron string or special alias.

  Returns CronTuple

  A CronTuple with ordered cron fields

  Throws

  Error if the expression is malformed.

  Example

  parser.toTuple( '0 1 * * SAT,SUN' );
  Copy

validate

• validate(expr: string): boolean

  Validate a cron expression without throwing.

  Parameters

  • expr: string

    The cron expression to validate.

  Returns boolean

  true if valid, false otherwise.

  Example

  parser.validate( '0 9 * * MON' );  // true
  parser.validate( '99 * * * *' );   // false
  Copy

StaticgetInstance

• getInstance(): CronParser

  Get the CronParser instance.

  Returns CronParser