Class ParsingComponents

A collection of parsed date/time components (e.g. day, hour, minute, ..., etc).

Each parsed component has three different levels of certainty.

Certain (or Known): The component is directly mentioned and parsed.
Implied: The component is not directly mentioned, but implied by other parsed information.
Unknown: Completely no mention of the component.

Implements

ParsedComponents

Constructors

constructor

new ParsingComponents(
    reference: ReferenceWithTimezone,
    knownComponents?: {
        day?: number;
        hour?: number;
        meridiem?: number;
        millisecond?: number;
        minute?: number;
        month?: number;
        second?: number;
        timezoneOffset?: number;
        weekday?: number;
        year?: number;
    },
): ParsingComponents
Parameters
- reference: ReferenceWithTimezone
- OptionalknownComponents: {
      day?: number;
      hour?: number;
      meridiem?: number;
      millisecond?: number;
      minute?: number;
      month?: number;
      second?: number;
      timezoneOffset?: number;
      weekday?: number;
      year?: number;
  }
Returns ParsingComponents
- Defined in results.ts:69

Methods

addDurationAsImplied

addDurationAsImplied(duration: Duration): ParsingComponents
Add the duration into this component, mark the modified date and/or time as implied.
Parameters
- duration: Duration
Returns ParsingComponents
- Defined in results.ts:173

addTag

addTag(tag: string): ParsingComponents
Parameters
- tag: string
Returns ParsingComponents
- Defined in results.ts:262

addTags

addTags(tags: string[] | Set<string>): ParsingComponents
Parameters
- tags: string[] | Set<string>
Returns ParsingComponents
- Defined in results.ts:267

assign

assign(component: Component, value: number): ParsingComponents
Parameters
- component: Component
- value: number
Returns ParsingComponents
- Defined in results.ts:163

clone

clone(): ParsingComponents
Returns ParsingComponents
- Defined in results.ts:202

date

date(): Date
Returns Date
a javascript date object.
Implementation of ParsedComponents.date
- Defined in results.ts:256

delete

delete(components: Component | Component[]): void
Parameters
- components: Component | Component[]
Returns void
- Defined in results.ts:192

get

get(component: Component): number
Get the component value for either Certain or Implied value.
Parameters
- component: Component
Returns number
Implementation of ParsedComponents.get
- Defined in results.ts:135

getCertainComponents

getCertainComponents(): Component[]
Returns Component[]
- Defined in results.ts:151

imply

imply(component: Component, value: number): ParsingComponents
Parameters
- component: Component
- value: number
Returns ParsingComponents
- Defined in results.ts:155

isCertain

isCertain(component: Component): boolean
Check the component certainly if the component is Certain (or Known)
Parameters
- component: Component
Returns boolean
Implementation of ParsedComponents.isCertain
- Defined in results.ts:147

isDateWithUnknownYear

isDateWithUnknownYear(): boolean
Returns boolean
- Defined in results.ts:232

isOnlyDate

isOnlyDate(): boolean
Returns boolean
- Defined in results.ts:218

isOnlyTime

isOnlyTime(): boolean
Returns boolean
- Defined in results.ts:222

isOnlyWeekdayComponent

isOnlyWeekdayComponent(): boolean
Returns boolean
- Defined in results.ts:228

isValidDate

isValidDate(): boolean
Returns boolean
- Defined in results.ts:236

tags

tags(): Set<string>
Returns Set<string>
debugging tags of the parsed component.
Implementation of ParsedComponents.tags
- Defined in results.ts:274

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in results.ts:248

`Static`createRelativeFromReference

createRelativeFromReference(
reference: ReferenceWithTimezone,
duration?: Duration,
): ParsingComponents
Parameters
- reference: ReferenceWithTimezone
- duration: Duration = EmptyDuration
Returns ParsingComponents
- Defined in results.ts:89