Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LfMetadataDatetimeUtils

Index

Functions

Functions

compareDateStrings

  • compareDateStrings(first: string, second: string): boolean

  • Compares two string formated dates/times

    example
    // suppose the timezone is PDT
    const datetimeString1 = '2021-03-25';
    const datetimeString2 = '2021-03-24T17:00:00';
    compareDateStrings(datetimeString1, datetimeString2); // true

    Parameters

    • first: string
    • second: string

    Returns boolean

    true if the string formated dates/times represent the same date/time

deserializeDateValue

  • deserializeDateValue(date: undefined | string): string

  • Given a string that represents a date object with no timezone offset, adds the offset based on the client's current timezone, and returns it as a string

    example
    // suppose the timezone is PDT
    const originalDateString: string = '2021-03-25';
    const originalDate: Date = new Date(originalDateString); 
    // originalDate -> Wed Mar 24 2021 17:00:00 GMT-0700 (Pacific Daylight Time)
     
    const deserializedDateString: string = deserializeDateValue(originalDateString);
    const deserializedDate: Date = new Date(deserializedDateString); 
    // deserializedDate -> Thu Mar 25 2021 00:00:00 GMT-0700 (Pacific Daylight Time)

    Parameters

    • date: undefined | string

      e.g. 2021-03-25, PDT timezone

    Returns string

    the date with an added offset of the current time "2021-03-25T07:00:00.000Z"

isValidDate

  • isValidDate(date: Date): boolean

  • Returns true if the date object contains a valid value

    example
    const datetimeString1: string = '2021-03-25T01:00:00';
    const datetime1: Date = new Date(datetimeString1);
    isValidDate(datetime1); // true

    const datetimeString2: string = '2021-03-25T26:00:72';
    const datetime2: Date = new Date(datetimeString2);
    isValidDate(datetime2); // false

    Parameters

    • date: Date

    Returns boolean

serializeDateValue

  • serializeDateValue(date: undefined | Date): string | undefined

  • Given a date object, returns a corresponding ISO8601 representating the localtime without offset

    example
    const originalDatetimeString: string = '2021-03-25T01:00:00-07:00';
    const datetimeNoOffset: Date = new Date(originalDatetimeString);
    // datetimeNoOffset -> Thu Mar 25 2021 01:00:00 GMT-0700 (Pacific Daylight Time)

    const serializedDatetime: string | undefined = serializeDateValue(datetimeNoOffset);
    // serializedDatetime -> 2021-03-25T01:00:00

    Parameters

    • date: undefined | Date

    Returns string | undefined

    a corresponding ISO8601 string representating the localtime without offset

Generated using TypeDoc