Interface moment

interface moment {
    constructor: Function;
    add(amount?: DurationInputArg1, unit?: DurationConstructor): moment;
    add(unit: DurationConstructor, amount: string | number): moment;
    calendar(): string;
    calendar(formats: CalendarSpec): string;
    calendar(time?: MomentInput, formats?: CalendarSpec): string;
    clone(): moment;
    creationData(): MomentCreationData;
    date(d: number): moment;
    date(): number;
    dates(d: number): moment;
    dates(): number;
    day(d: string | number): moment;
    day(): number;
    dayOfYear(): number;
    dayOfYear(d: number): moment;
    days(d: string | number): moment;
    days(): number;
    daysInMonth(): number;
    diff(b: MomentInput, unitOfTime?: Diff, precise?: boolean): number;
    endOf(unitOfTime: StartOf): moment;
    format(format?: string): string;
    from(inp: MomentInput, suffix?: boolean): string;
    fromNow(withoutSuffix?: boolean): string;
    get(unit: All): number;
    hasAlignedHourOffset(other?: MomentInput): boolean;
    hasOwnProperty(v: PropertyKey): boolean;
    hour(h: number): moment;
    hour(): number;
    hours(h: number): moment;
    hours(): number;
    inspect(): string;
    invalidAt(): number;
    isAfter(inp?: MomentInput, granularity?: StartOf): boolean;
    isBefore(inp?: MomentInput, granularity?: StartOf): boolean;
    isBetween(a: MomentInput, b: MomentInput, granularity?: StartOf, inclusivity?:
        | "()"
        | "[)"
        | "(]"
        | "[]"): boolean;
    isDST(): boolean;
    isDSTShifted(): boolean;
    isLeapYear(): boolean;
    isLocal(): boolean;
    isPrototypeOf(v: Object): boolean;
    isSame(inp?: MomentInput, granularity?: StartOf): boolean;
    isSameOrAfter(inp?: MomentInput, granularity?: StartOf): boolean;
    isSameOrBefore(inp?: MomentInput, granularity?: StartOf): boolean;
    isUTC(): boolean;
    isUtc(): boolean;
    isUtcOffset(): boolean;
    isValid(): boolean;
    isoWeek(): number;
    isoWeek(d: number): moment;
    isoWeekYear(): number;
    isoWeekYear(d: number): moment;
    isoWeekday(): number;
    isoWeekday(d: string | number): moment;
    isoWeeks(): number;
    isoWeeks(d: number): moment;
    isoWeeksInISOWeekYear(): number;
    isoWeeksInYear(): number;
    lang(language: LocaleSpecifier): moment;
    lang(): Locale;
    local(keepLocalTime?: boolean): moment;
    locale(): string;
    locale(locale: LocaleSpecifier): moment;
    localeData(): Locale;
    max(inp?: MomentInput, format?: MomentFormatSpecification, strict?: boolean): moment;
    max(inp?: MomentInput, format?: MomentFormatSpecification, language?: string, strict?: boolean): moment;
    millisecond(ms: number): moment;
    millisecond(): number;
    milliseconds(ms: number): moment;
    milliseconds(): number;
    min(inp?: MomentInput, format?: MomentFormatSpecification, strict?: boolean): moment;
    min(inp?: MomentInput, format?: MomentFormatSpecification, language?: string, strict?: boolean): moment;
    minute(m: number): moment;
    minute(): number;
    minutes(m: number): moment;
    minutes(): number;
    month(M: string | number): moment;
    month(): number;
    months(M: string | number): moment;
    months(): number;
    parseZone(): moment;
    parsingFlags(): MomentParsingFlags;
    propertyIsEnumerable(v: PropertyKey): boolean;
    quarter(): number;
    quarter(q: number): moment;
    quarters(): number;
    quarters(q: number): moment;
    second(s: number): moment;
    second(): number;
    seconds(s: number): moment;
    seconds(): number;
    set(unit: All, value: number): moment;
    set(objectLiteral: MomentSetObject): moment;
    startOf(unitOfTime: StartOf): moment;
    subtract(amount?: DurationInputArg1, unit?: DurationConstructor): moment;
    subtract(unit: DurationConstructor, amount: string | number): moment;
    to(inp: MomentInput, suffix?: boolean): string;
    toArray(): [number, number, number, number, number, number, number];
    toDate(): Date;
    toISOString(keepOffset?: boolean): string;
    toJSON(): string;
    toLocaleString(): string;
    toNow(withoutPrefix?: boolean): string;
    toObject(): MomentObjectOutput;
    toString(): string;
    tz(): undefined | string;
    tz(timezone: string, keepLocalTime?: boolean): moment;
    unix(): number;
    utc(keepLocalTime?: boolean): moment;
    utcOffset(): number;
    utcOffset(b: string | number, keepLocalTime?: boolean): moment;
    valueOf(): number;
    week(): number;
    week(d: number): moment;
    weekYear(): number;
    weekYear(d: number): moment;
    weekday(): number;
    weekday(d: number): moment;
    weeks(): number;
    weeks(d: number): moment;
    weeksInYear(): number;
    year(y: number): moment;
    year(): number;
    years(y: number): moment;
    years(): number;
    zone(): number;
    zone(b: string | number): moment;
    zoneAbbr(): string;
    zoneAbbr(): string;
    zoneName(): string;
    zoneName(): string;
}

Hierarchy

  • Object
    • moment

Properties

constructor

Methods

add calendar clone creationData date dates day dayOfYear days daysInMonth diff endOf format from fromNow get hasAlignedHourOffset hasOwnProperty hour hours inspect invalidAt isAfter isBefore isBetween isDST isDSTShifted isLeapYear isLocal isPrototypeOf isSame isSameOrAfter isSameOrBefore isUTC isUtc isUtcOffset isValid isoWeek isoWeekYear isoWeekday isoWeeks isoWeeksInISOWeekYear isoWeeksInYear lang local locale localeData max millisecond milliseconds min minute minutes month months parseZone parsingFlags propertyIsEnumerable quarter quarters second seconds set startOf subtract to toArray toDate toISOString toJSON toLocaleString toNow toObject toString tz unix utc utcOffset valueOf week weekYear weekday weeks weeksInYear year years zone zoneAbbr zoneName

Properties

constructor

constructor: Function

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Methods

add

  • add(amount?, unit?): moment

  • Parameters

    • Optionalamount: DurationInputArg1
    • Optionalunit: DurationConstructor

    Returns moment

  • add(unit, amount): moment

  • Parameters

    • unit: DurationConstructor
    • amount: string | number

    Returns moment

    Deprecated

    reverse syntax

calendar

  • calendar(): string

  • Returns string

  • calendar(formats): string

  • Parameters

    • formats: CalendarSpec

    Returns string

  • calendar(time?, formats?): string

  • Parameters

    • Optionaltime: MomentInput
    • Optionalformats: CalendarSpec

    Returns string

clone

creationData

  • creationData(): MomentCreationData

  • Returns MomentCreationData

date

  • date(d): moment

  • Parameters

    • d: number

    Returns moment

  • date(): number

  • Returns number

dates

  • dates(d): moment

  • Parameters

    • d: number

    Returns moment

    Deprecated

    use date(d)

  • dates(): number

  • Returns number

    Deprecated

    use date()

day

  • day(d): moment

  • Parameters

    • d: string | number

    Returns moment

  • day(): number

  • Returns number

dayOfYear

  • dayOfYear(): number

  • Returns number

  • dayOfYear(d): moment

  • Parameters

    • d: number

    Returns moment

days

  • days(d): moment

  • Parameters

    • d: string | number

    Returns moment

  • days(): number

  • Returns number

daysInMonth

  • daysInMonth(): number

  • Returns number

diff

  • diff(b, unitOfTime?, precise?): number

  • Parameters

    • b: MomentInput
    • OptionalunitOfTime: Diff
    • Optionalprecise: boolean

    Returns number

endOf

  • endOf(unitOfTime): moment

  • Parameters

    • unitOfTime: StartOf

    Returns moment

format

  • format(format?): string

  • Parameters

    • Optionalformat: string

    Returns string

from

  • from(inp, suffix?): string

  • Parameters

    • inp: MomentInput
    • Optionalsuffix: boolean

    Returns string

fromNow

  • fromNow(withoutSuffix?): string

  • Parameters

    • OptionalwithoutSuffix: boolean

    Returns string

get

  • get(unit): number

  • Parameters

    • unit: All

    Returns number

hasAlignedHourOffset

  • hasAlignedHourOffset(other?): boolean

  • Parameters

    • Optionalother: MomentInput

    Returns boolean

hasOwnProperty

  • hasOwnProperty(v): boolean

  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

hour

  • hour(h): moment

  • Parameters

    • h: number

    Returns moment

  • hour(): number

  • Returns number

hours

  • hours(h): moment

  • Parameters

    • h: number

    Returns moment

  • hours(): number

  • Returns number

inspect

  • inspect(): string

  • Returns string

invalidAt

  • invalidAt(): number

  • Returns number

isAfter

  • isAfter(inp?, granularity?): boolean

  • Parameters

    • Optionalinp: MomentInput
    • Optionalgranularity: StartOf

    Returns boolean

isBefore

  • isBefore(inp?, granularity?): boolean

  • Parameters

    • Optionalinp: MomentInput
    • Optionalgranularity: StartOf

    Returns boolean

isBetween

  • isBetween(a, b, granularity?, inclusivity?): boolean

  • Parameters

    • a: MomentInput
    • b: MomentInput
    • Optionalgranularity: StartOf
    • Optionalinclusivity:
          | "()"
          | "[)"
          | "(]"
          | "[]"

    Returns boolean

isDST

  • isDST(): boolean

  • Returns boolean

isDSTShifted

  • isDSTShifted(): boolean

  • Returns boolean

    Deprecated

    no reliable implementation

isLeapYear

  • isLeapYear(): boolean

  • Returns boolean

isLocal

  • isLocal(): boolean

  • Returns boolean

isPrototypeOf

  • isPrototypeOf(v): boolean

  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

isSame

  • isSame(inp?, granularity?): boolean

  • Parameters

    • Optionalinp: MomentInput
    • Optionalgranularity: StartOf

    Returns boolean

isSameOrAfter

  • isSameOrAfter(inp?, granularity?): boolean

  • Parameters

    • Optionalinp: MomentInput
    • Optionalgranularity: StartOf

    Returns boolean

isSameOrBefore

  • isSameOrBefore(inp?, granularity?): boolean

  • Parameters

    • Optionalinp: MomentInput
    • Optionalgranularity: StartOf

    Returns boolean

isUTC

  • isUTC(): boolean

  • Returns boolean

isUtc

  • isUtc(): boolean

  • Returns boolean

    Deprecated

    use isUTC

isUtcOffset

  • isUtcOffset(): boolean

  • Returns boolean

isValid

  • isValid(): boolean

  • Returns boolean

isoWeek

  • isoWeek(): number

  • Returns number

  • isoWeek(d): moment

  • Parameters

    • d: number

    Returns moment

isoWeekYear

  • isoWeekYear(): number

  • Returns number

  • isoWeekYear(d): moment

  • Parameters

    • d: number

    Returns moment

isoWeekday

  • isoWeekday(): number

  • Returns number

  • isoWeekday(d): moment

  • Parameters

    • d: string | number

    Returns moment

isoWeeks

  • isoWeeks(): number

  • Returns number

  • isoWeeks(d): moment

  • Parameters

    • d: number

    Returns moment

isoWeeksInISOWeekYear

  • isoWeeksInISOWeekYear(): number

  • Returns number

isoWeeksInYear

  • isoWeeksInYear(): number

  • Returns number

lang

  • lang(language): moment

  • Parameters

    • language: LocaleSpecifier

    Returns moment

    Deprecated

    as of 2.8.0, use locale

  • lang(): Locale

  • Returns Locale

    Deprecated

    as of 2.8.0, use locale

local

  • local(keepLocalTime?): moment

  • Parameters

    • OptionalkeepLocalTime: boolean

    Returns moment

locale

  • locale(): string

  • Returns string

  • locale(locale): moment

  • Parameters

    • locale: LocaleSpecifier

    Returns moment

localeData

  • localeData(): Locale

  • Returns Locale

max

  • max(inp?, format?, strict?): moment

  • Parameters

    • Optionalinp: MomentInput
    • Optionalformat: MomentFormatSpecification
    • Optionalstrict: boolean

    Returns moment

    Deprecated

    as of 2.7.0, use moment.min/max

  • max(inp?, format?, language?, strict?): moment

  • Parameters

    • Optionalinp: MomentInput
    • Optionalformat: MomentFormatSpecification
    • Optionallanguage: string
    • Optionalstrict: boolean

    Returns moment

    Deprecated

    as of 2.7.0, use moment.min/max

millisecond

  • millisecond(ms): moment

  • Parameters

    • ms: number

    Returns moment

  • millisecond(): number

  • Returns number

milliseconds

  • milliseconds(ms): moment

  • Parameters

    • ms: number

    Returns moment

  • milliseconds(): number

  • Returns number

min

  • min(inp?, format?, strict?): moment

  • Parameters

    • Optionalinp: MomentInput
    • Optionalformat: MomentFormatSpecification
    • Optionalstrict: boolean

    Returns moment

    Deprecated

    as of 2.7.0, use moment.min/max

  • min(inp?, format?, language?, strict?): moment

  • Parameters

    • Optionalinp: MomentInput
    • Optionalformat: MomentFormatSpecification
    • Optionallanguage: string
    • Optionalstrict: boolean

    Returns moment

    Deprecated

    as of 2.7.0, use moment.min/max

minute

  • minute(m): moment

  • Parameters

    • m: number

    Returns moment

  • minute(): number

  • Returns number

minutes

  • minutes(m): moment

  • Parameters

    • m: number

    Returns moment

  • minutes(): number

  • Returns number

month

  • month(M): moment

  • Parameters

    • M: string | number

    Returns moment

  • month(): number

  • Returns number

months

  • months(M): moment

  • Parameters

    • M: string | number

    Returns moment

    Deprecated

    use month(M)

  • months(): number

  • Returns number

    Deprecated

    use month()

parseZone

parsingFlags

  • parsingFlags(): MomentParsingFlags

  • Returns MomentParsingFlags

propertyIsEnumerable

  • propertyIsEnumerable(v): boolean

  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

quarter

  • quarter(): number

  • Returns number

  • quarter(q): moment

  • Parameters

    • q: number

    Returns moment

quarters

  • quarters(): number

  • Returns number

  • quarters(q): moment

  • Parameters

    • q: number

    Returns moment

second

  • second(s): moment

  • Parameters

    • s: number

    Returns moment

  • second(): number

  • Returns number

seconds

  • seconds(s): moment

  • Parameters

    • s: number

    Returns moment

  • seconds(): number

  • Returns number

set

  • set(unit, value): moment

  • Parameters

    • unit: All
    • value: number

    Returns moment

  • set(objectLiteral): moment

  • Parameters

    • objectLiteral: MomentSetObject

    Returns moment

startOf

  • startOf(unitOfTime): moment

  • Parameters

    • unitOfTime: StartOf

    Returns moment

subtract

  • subtract(amount?, unit?): moment

  • Parameters

    • Optionalamount: DurationInputArg1
    • Optionalunit: DurationConstructor

    Returns moment

  • subtract(unit, amount): moment

  • Parameters

    • unit: DurationConstructor
    • amount: string | number

    Returns moment

    Deprecated

    reverse syntax

to

  • to(inp, suffix?): string

  • Parameters

    • inp: MomentInput
    • Optionalsuffix: boolean

    Returns string

toArray

  • toArray(): [number, number, number, number, number, number, number]

  • Returns [number, number, number, number, number, number, number]

toDate

  • toDate(): Date

  • Returns Date

toISOString

  • toISOString(keepOffset?): string

  • Parameters

    • OptionalkeepOffset: boolean

    Returns string

toJSON

  • toJSON(): string

  • Returns string

toLocaleString

  • toLocaleString(): string

  • Returns a date converted to a string using the current locale.

    Returns string

toNow

  • toNow(withoutPrefix?): string

  • Parameters

    • OptionalwithoutPrefix: boolean

    Returns string

toObject

  • toObject(): MomentObjectOutput

  • Returns MomentObjectOutput

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

tz

  • tz(): undefined | string

  • Returns undefined | string

  • tz(timezone, keepLocalTime?): moment

  • Parameters

    • timezone: string
    • OptionalkeepLocalTime: boolean

    Returns moment

unix

  • unix(): number

  • Returns number

utc

  • utc(keepLocalTime?): moment

  • Parameters

    • OptionalkeepLocalTime: boolean

    Returns moment

utcOffset

  • utcOffset(): number

  • Returns number

  • utcOffset(b, keepLocalTime?): moment

  • Parameters

    • b: string | number
    • OptionalkeepLocalTime: boolean

    Returns moment

valueOf

  • valueOf(): number

  • Returns number

    Unix timestamp in milliseconds

week

  • week(): number

  • Returns number

  • week(d): moment

  • Parameters

    • d: number

    Returns moment

weekYear

  • weekYear(): number

  • Returns number

  • weekYear(d): moment

  • Parameters

    • d: number

    Returns moment

weekday

  • weekday(): number

  • Returns number

  • weekday(d): moment

  • Parameters

    • d: number

    Returns moment

weeks

  • weeks(): number

  • Returns number

  • weeks(d): moment

  • Parameters

    • d: number

    Returns moment

weeksInYear

  • weeksInYear(): number

  • Returns number

year

  • year(y): moment

  • Parameters

    • y: number

    Returns moment

  • year(): number

  • Returns number

years

  • years(y): moment

  • Parameters

    • y: number

    Returns moment

    Deprecated

    use year(y)

  • years(): number

  • Returns number

    Deprecated

    use year()

zone

  • zone(): number

  • Returns number

    Deprecated

    in favor of utcOffset

  • zone(b): moment

  • Parameters

    • b: string | number

    Returns moment

zoneAbbr

  • zoneAbbr(): string

  • Returns string

  • zoneAbbr(): string

  • Returns string

zoneName

  • zoneName(): string

  • Returns string

  • zoneName(): string

  • Returns string

Settings

Member Visibility

On This Page

Properties
Methods