Header menu logo Xanthos

Validation Module

Functions and values

Function or value Description

buildOpenRequest rawSpec rawFrom rawOption

Full Usage: buildOpenRequest rawSpec rawFrom rawOption

Parameters:
    rawSpec : string
    rawFrom : string option
    rawOption : string option

Returns: Result<JvOpenRequest, XanthosError>

Validates and builds a JvOpenRequest from raw CLI parameters.

rawSpec : string
rawFrom : string option
rawOption : string option
Returns: Result<JvOpenRequest, XanthosError>

createOpenRequest spec fromTime option

Full Usage: createOpenRequest spec fromTime option

Parameters:
    spec : string
    fromTime : DateTime
    option : int

Returns: JvOpenRequest

Constructs a JvOpenRequest from validated inputs.

spec : string
fromTime : DateTime
option : int
Returns: JvOpenRequest

normalizeDataspec spec

Full Usage: normalizeDataspec spec

Parameters:
    spec : string

Returns: Result<string, XanthosError>

Normalises and validates the dataspec string (must be a multiple of 4 alphanumeric characters).

spec : string
Returns: Result<string, XanthosError>

normalizeRealtimeKey key

Full Usage: normalizeRealtimeKey key

Parameters:
    key : string - Raw key string from caller

Returns: Result<string, XanthosError> Normalized key or ValidationError

Validates and normalizes a realtime API key for JVRTOpen.

Per JVRTOpen specification, valid key formats are:

  • YYYYMMDDJJKKHHRR (16 digits): Race-by-race request
  • YYYYMMDDJJRR (12 digits): Simplified race-by-race request
  • YYYYMMDD (8 digits): Daily request
  • WatchEvent key (starts with "0B"): Event-triggered request
All digits must be half-width ASCII (0-9).

key : string

Raw key string from caller

Returns: Result<string, XanthosError>

Normalized key or ValidationError

parseFromTime text

Full Usage: parseFromTime text

Parameters:
    text : string option

Returns: Result<DateTime, XanthosError>

Parses the required JVOpen fromTime (yyyyMMddHHmmss or yyyyMMdd).

text : string option
Returns: Result<DateTime, XanthosError>

parseOpenOption text

Full Usage: parseOpenOption text

Parameters:
    text : string option

Returns: Result<int, XanthosError>

Parses the optional JVOpen option value, defaulting to 1 when unspecified.

text : string option
Returns: Result<int, XanthosError>

Type something to start searching.