chrono-node/dist/esm/chrono.d.ts

A natural language date parser in Javascript

import { ReferenceWithTimezone, ParsingComponents, ParsingResult } from "./results.js";
import { Component, ParsedResult, ParsingOption, ParsingReference } from "./types.js";
import { AsyncDebugBlock, DebugHandler } from "./debugging.js";
import ENDefaultConfiguration from "./locales/en/configuration.js";
export interface Configuration {
    parsers: Parser[];
    refiners: Refiner[];
}
export interface Parser {
    pattern(context: ParsingContext): RegExp;
    extract(context: ParsingContext, match: RegExpMatchArray): ParsingComponents | ParsingResult | {
        [c in Component]?: number;
    } | null;
}
export interface Refiner {
    refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];
}
export declare class Chrono {
    parsers: Array<Parser>;
    refiners: Array<Refiner>;
    defaultConfig: ENDefaultConfiguration;
    constructor(configuration?: Configuration);
    clone(): Chrono;
    parseDate(text: string, referenceDate?: ParsingReference | Date, option?: ParsingOption): Date | null;
    parse(text: string, referenceDate?: ParsingReference | Date, option?: ParsingOption): ParsedResult[];
    private static executeParser;
}
export declare class ParsingContext implements DebugHandler {
    readonly text: string;
    readonly option: ParsingOption;
    readonly reference: ReferenceWithTimezone;
    readonly refDate: Date;
    constructor(text: string, refDate?: ParsingReference | Date, option?: ParsingOption);
    createParsingComponents(components?: {
        [c in Component]?: number;
    } | ParsingComponents): ParsingComponents;
    createParsingResult(index: number, textOrEndIndex: number | string, startComponents?: {
        [c in Component]?: number;
    } | ParsingComponents, endComponents?: {
        [c in Component]?: number;
    } | ParsingComponents): ParsingResult;
    debug(block: AsyncDebugBlock): void;
}