Documentation / @jalali-js/nlp / parse

Function: parse()

parse(input, locale, options?): CalendarDate | null

Defined in: parse.ts:64

Reads a natural language date phrase in the given input style and returns the calendar date it names, or null when the phrase is not one this parser recognizes. This covers a fixed, testable set of relative terms and month phrases (see architecture.md's "Natural language date parsing"); it is not a general natural language engine.

Parameters

input

string

locale

NlpLocale

options?

ParseOptions = {}

Returns

CalendarDate | null