chrono-node

chrono-node

Version 2.7.5
Published 3 months ago
2.62 MB
1 dependency
MIT license

Install

npm i chrono-node

yarn add chrono-node

pnpm add chrono-node

Overview

A natural language date parser in Javascript

Index

Variables

variable casual

const casual: en.Chrono;

variable strict

const strict: en.Chrono;

Functions

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

Classes

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

Interfaces

interface ParsedComponents

interface ParsedComponents {}

method date

date: () => Date;

method get

get: (component: Component) => number | null;

method isCertain

isCertain: (component: Component) => boolean;

method tags

tags: () => Set<string>;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

Enums

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

Type Aliases

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

Namespaces

namespace de

module 'dist/esm/locales/de/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: (littleEndian?: boolean) => Configuration;

function createConfiguration

createConfiguration: (
    strictMode?: boolean,
    littleEndian?: boolean
) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace en

module 'dist/esm/locales/en/index.d.ts' {}

variable casual

const casual: Chrono;

variable configuration

const configuration: ENDefaultConfiguration;

variable GB

const GB: Chrono;

variable strict

const strict: Chrono;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace es

module 'dist/esm/locales/es/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: (littleEndian?: boolean) => Configuration;

function createConfiguration

createConfiguration: (
    strictMode?: boolean,
    littleEndian?: boolean
) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace fr

module 'dist/esm/locales/fr/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: (littleEndian?: boolean) => Configuration;

function createConfiguration

createConfiguration: (
    strictMode?: boolean,
    littleEndian?: boolean
) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace ja

module 'dist/esm/locales/ja/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: () => Configuration;

function createConfiguration

createConfiguration: () => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace nl

module 'dist/esm/locales/nl/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: (littleEndian?: boolean) => Configuration;

function createConfiguration

createConfiguration: (
    strictMode?: boolean,
    littleEndian?: boolean
) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace pt

module 'dist/esm/locales/pt/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: (littleEndian?: boolean) => Configuration;

function createConfiguration

createConfiguration: (
    strictMode?: boolean,
    littleEndian?: boolean
) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace ru

module 'dist/esm/locales/ru/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: () => Configuration;

function createConfiguration

createConfiguration: (strictMode?: boolean) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace uk

module 'dist/esm/locales/uk/index.d.ts' {}

variable casual

const casual: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: () => Configuration;

function createConfiguration

createConfiguration: (strictMode: boolean) => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace zh

module 'dist/esm/locales/zh/index.d.ts' {}

variable casual

const casual: Chrono;

variable hant

const hant: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: () => Configuration;

function createConfiguration

createConfiguration: () => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

namespace hans

module 'dist/esm/locales/zh/hans/index.d.ts' {}

variable casual

const casual: Chrono;

variable hans

const hans: Chrono;

variable strict

const strict: Chrono;

function createCasualConfiguration

createCasualConfiguration: () => Configuration;

function createConfiguration

createConfiguration: () => Configuration;

function parse

parse: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

function parseDate

parseDate: (
    text: string,
    ref?: ParsingReference | Date,
    option?: ParsingOption
) => Date;

class Chrono

class Chrono {}

constructor

constructor(configuration?: Configuration);

property defaultConfig

defaultConfig: ENDefaultConfiguration;

property parsers

parsers: Parser[];

property refiners

refiners: Refiner[];

method clone

clone: () => Chrono;

method parse

parse: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => ParsedResult[];

method parseDate

parseDate: (
    text: string,
    referenceDate?: ParsingReference | Date,
    option?: ParsingOption
) => Date | null;

class ParsingComponents

class ParsingComponents implements ParsedComponents {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        year?: number;
        month?: number;
        day?: number;
        weekday?: number;
        hour?: number;
        minute?: number;
        second?: number;
        millisecond?: number;
        meridiem?: number;
        timezoneOffset?: number;
    }
);

method addTag

addTag: (tag: string) => ParsingComponents;

method addTags

addTags: (tags: string[] | Set<string>) => ParsingComponents;

method assign

assign: (component: Component, value: number) => ParsingComponents;

method clone

clone: () => ParsingComponents;

method createRelativeFromReference

static createRelativeFromReference: (
    reference: ReferenceWithTimezone,
    fragments: { [x: string]: number }
) => ParsingComponents;

method date

date: () => Date;

method dayjs

dayjs: () => dayjs.Dayjs;

method delete

delete: (component: Component) => void;

method get

get: (component: Component) => number | null;

method getCertainComponents

getCertainComponents: () => Array<Component>;

method imply

imply: (component: Component, value: number) => ParsingComponents;

method isCertain

isCertain: (component: Component) => boolean;

method isDateWithUnknownYear

isDateWithUnknownYear: () => boolean;

method isOnlyDate

isOnlyDate: () => boolean;

method isOnlyTime

isOnlyTime: () => boolean;

method isOnlyWeekdayComponent

isOnlyWeekdayComponent: () => boolean;

method isValidDate

isValidDate: () => boolean;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ParsingResult

class ParsingResult implements ParsedResult {}

constructor

constructor(
    reference: ReferenceWithTimezone,
    index: number,
    text: string,
    start?: ParsingComponents,
    end?: ParsingComponents
);

property end

end?: ParsingComponents;

property index

index: number;

property refDate

refDate: Date;

property reference

reference: ReferenceWithTimezone;

property start

start: ParsingComponents;

property text

text: string;

method clone

clone: () => ParsingResult;

method date

date: () => Date;

method tags

tags: () => Set<string>;

method toString

toString: () => string;

class ReferenceWithTimezone

class ReferenceWithTimezone {}

constructor

constructor(input?: ParsingReference | Date);

property instant

readonly instant: Date;

property timezoneOffset

readonly timezoneOffset?: number;

method getDateWithAdjustedTimezone

getDateWithAdjustedTimezone: () => Date;

method getSystemTimezoneAdjustmentMinute

getSystemTimezoneAdjustmentMinute: (
    date?: Date,
    overrideTimezoneOffset?: number
) => number;

interface ParsedResult

interface ParsedResult {}

property end

readonly end?: ParsedComponents;

property index

readonly index: number;

property refDate

readonly refDate: Date;

property start

readonly start: ParsedComponents;

property text

readonly text: string;

method date

date: () => Date;

method tags

tags: () => Set<string>;

interface Parser

interface Parser {}

method extract

extract: (
    context: ParsingContext,
    match: RegExpMatchArray
) =>
    | ParsingComponents
    | ParsingResult
    | {
          year?: number;
          month?: number;
          day?: number;
          weekday?: number;
          hour?: number;
          minute?: number;
          second?: number;
          millisecond?: number;
          meridiem?: number;
          timezoneOffset?: number;
      };

method pattern

pattern: (context: ParsingContext) => RegExp;

interface ParsingOption

interface ParsingOption {}

property forwardDate

forwardDate?: boolean;

property timezones

timezones?: TimezoneAbbrMap;

interface ParsingReference

interface ParsingReference {}

property instant

instant?: Date;

property timezone

timezone?: string | number;

interface Refiner

interface Refiner {}

property refine

refine: (context: ParsingContext, results: ParsingResult[]) => ParsingResult[];

enum Meridiem

enum Meridiem {
    AM = 0,
    PM = 1,
}

member AM

AM = 0

member PM

PM = 1

enum Weekday

enum Weekday {
    SUNDAY = 0,
    MONDAY = 1,
    TUESDAY = 2,
    WEDNESDAY = 3,
    THURSDAY = 4,
    FRIDAY = 5,
    SATURDAY = 6,
}

member FRIDAY

FRIDAY = 5

member MONDAY

MONDAY = 1

member SATURDAY

SATURDAY = 6

member SUNDAY

SUNDAY = 0

member THURSDAY

THURSDAY = 4

member TUESDAY

TUESDAY = 2

member WEDNESDAY

WEDNESDAY = 3

type Component

type Component =
    | 'year'
    | 'month'
    | 'day'
    | 'weekday'
    | 'hour'
    | 'minute'
    | 'second'
    | 'millisecond'
    | 'meridiem'
    | 'timezoneOffset';

Package Files (16)

Dependencies (1)

dayjs

Dev Dependencies (15)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/chrono-node.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/chrono-node)

HTML

<a href="https://www.jsdocs.io/package/chrono-node"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 3 months ago.
Package analyzed in 11307 ms.
Missing or incorrect documentation? Open an issue for this package.