Class Timestamp

Hierarchy (view full)

Constructors

constructor

Properties

__isLong__ add and comp compare div divide eq equals eqz ge getHighBits getHighBitsUnsigned getLowBits getLowBitsUnsigned getNumBitsAbs greaterThan greaterThanOrEqual gt gte high isEven isNegative isOdd isPositive isZero le lessThan lessThanOrEqual low lt lte mod modulo mul multiply ne neg negate neq not notEquals or rem shiftLeft shiftRight shiftRightUnsigned shl shr shr_u shru sub subtract toBigInt toBytes toBytesBE toBytesLE toInt toNumber toSigned toString toUnsigned unsigned xor MAX_VALUE

Accessors

_bsontype [bsonType] i t

Methods

inspect toJSON fromBits fromInt fromNumber fromString

Constructors

constructor

  • new Timestamp(int): Timestamp

  • Parameters

    • int: bigint

      A 64-bit bigint representing the Timestamp.

    Returns Timestamp

  • new Timestamp(long): Timestamp

  • Parameters

    • long: Long

      A 64-bit Long representing the Timestamp.

    Returns Timestamp

  • new Timestamp(value): Timestamp

  • Parameters

    • value: {
          i: number;
          t: number;
      }

      A pair of two values indicating timestamp and increment.

      • i: number
      • t: number

    Returns Timestamp

Properties

__isLong__

__isLong__: boolean

Deprecated

Not applicable to Timestamp. Use the bsonType symbol or _bsontype === 'Timestamp' to identify a Timestamp.

add

add: ((addend:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

    • (addend): Long

    • Returns the sum of this and the specified Long.

      Parameters

      • addend:
            | string
            | number
            | Long
            | Timestamp

      Returns Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

and

and: ((other:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

    • (other): Long

    • Returns the sum of this and the specified Long.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns Long

      Sum

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

comp

comp: ((other:
    | string
    | number
    | Long
    | Timestamp) => -1 | 0 | 1)

Type declaration

    • (other): -1 | 0 | 1

    • This is an alias of Long.compare

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns -1 | 0 | 1

Deprecated

Use .compare() for general comparison, or .equals(), .lessThan(), .greaterThan() for specific cases.

compare

compare: ((other:
    | string
    | number
    | Long
    | Timestamp) => -1 | 0 | 1)

Type declaration

    • (other): -1 | 0 | 1

    • Compares this Long's value with the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns -1 | 0 | 1

      0 if they are the same, 1 if the this is greater and -1 if the given one is greater

div

div: ((divisor:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

divide

divide: ((divisor:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

    • (divisor): Long

    • Returns this Long divided by the specified. The result is signed if this Long is signed or unsigned if this Long is unsigned.

      Parameters

      • divisor:
            | string
            | number
            | Long
            | Timestamp

      Returns Long

      Quotient

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

eq

eq: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • This is an alias of Long.equals

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

equals

equals: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • Tests if this Long's value equals the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

        Other value

      Returns boolean

eqz

eqz: (() => boolean)

Type declaration

    • (): boolean

    • This is an alias of Long.isZero

      Returns boolean

Deprecated

Compare .t and .i against 0 explicitly.

ge

ge: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

getHighBits

getHighBits: (() => number)

Type declaration

    • (): number

    • Gets the high 32 bits as a signed integer.

      Returns number

Deprecated

Incompatible with Timestamp: returns a signed integer, but Timestamp is always unsigned. Use .t for seconds since the Unix epoch.

getHighBitsUnsigned

getHighBitsUnsigned: (() => number)

Type declaration

    • (): number

    • Gets the high 32 bits as an unsigned integer.

      Returns number

Deprecated

Not applicable to Timestamp; use .t for seconds since the Unix epoch.

getLowBits

getLowBits: (() => number)

Type declaration

    • (): number

    • Gets the low 32 bits as a signed integer.

      Returns number

Deprecated

Incompatible with Timestamp: returns a signed integer, but Timestamp is always unsigned. Use .i for the increment ordinal.

getLowBitsUnsigned

getLowBitsUnsigned: (() => number)

Type declaration

    • (): number

    • Gets the low 32 bits as an unsigned integer.

      Returns number

Deprecated

Not applicable to Timestamp; use .i for the increment ordinal.

getNumBitsAbs

getNumBitsAbs: (() => number)

Type declaration

    • (): number

    • Gets the number of bits needed to represent the absolute value of this Long.

      Returns number

Deprecated

Not applicable to Timestamp.

greaterThan

greaterThan: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • Tests if this Long's value is greater than the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

greaterThanOrEqual

greaterThanOrEqual: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • Tests if this Long's value is greater than or equal the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

gt

gt: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • This is an alias of Long.greaterThan

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

gte

gte: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

high

high: number

Deprecated

Not applicable to Timestamp; use .t instead.

isEven

isEven: (() => boolean)

Type declaration

    • (): boolean

    • Tests if this Long's value is even.

      Returns boolean

Deprecated

Not applicable to Timestamp; tests parity of the increment only.

isNegative

isNegative: (() => boolean)

Type declaration

    • (): boolean

    • Tests if this Long's value is negative.

      Returns boolean

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned (is always false).

isOdd

isOdd: (() => boolean)

Type declaration

    • (): boolean

    • Tests if this Long's value is odd.

      Returns boolean

Deprecated

Not applicable to Timestamp; tests parity of the increment only.

isPositive

isPositive: (() => boolean)

Type declaration

    • (): boolean

    • Tests if this Long's value is positive.

      Returns boolean

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned (is always true).

isZero

isZero: (() => boolean)

Type declaration

    • (): boolean

    • Tests if this Long's value equals zero.

      Returns boolean

Deprecated

Compare .t and .i against 0 explicitly.

le

le: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

lessThan

lessThan: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • Tests if this Long's value is less than the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

lessThanOrEqual

lessThanOrEqual: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • Tests if this Long's value is less than or equal the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

low

low: number

Deprecated

Not applicable to Timestamp; use .i instead.

lt

lt: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • This is an alias of Long#lessThan.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

lte

lte: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

mod

mod: ((divisor:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

modulo

modulo: ((divisor:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

    • (divisor): Long

    • Returns this Long modulo the specified.

      Parameters

      • divisor:
            | string
            | number
            | Long
            | Timestamp

      Returns Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

mul

mul: ((multiplier:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

multiply

multiply: ((multiplier:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

    • (multiplier): Long

    • Returns the product of this and the specified Long.

      Parameters

      • multiplier:
            | string
            | number
            | Long
            | Timestamp

        Multiplier

      Returns Long

      Product

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

ne

ne: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • This is an alias of Long.notEquals

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

neg

neg: (() => Long)

Type declaration

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned.

negate

negate: (() => Long)

Type declaration

    • (): Long

    • Returns the Negation of this Long's value.

      Returns Long

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned.

neq

neq: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • This is an alias of Long.notEquals

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

not

not: (() => Long)

Type declaration

    • (): Long

    • Returns the bitwise NOT of this Long.

      Returns Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

notEquals

notEquals: ((other:
    | string
    | number
    | Long
    | Timestamp) => boolean)

Type declaration

    • (other): boolean

    • Tests if this Long's value differs from the specified's.

      Parameters

      • other:
            | string
            | number
            | Long
            | Timestamp

      Returns boolean

or

or: ((other: string | number | Long) => Long)

Type declaration

    • (other): Long

    • Returns the bitwise OR of this Long and the specified.

      Parameters

      • other: string | number | Long

      Returns Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

rem

rem: ((divisor:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shiftLeft

shiftLeft: ((numBits: number | Long) => Long)

Type declaration

    • (numBits): Long

    • Returns this Long with bits shifted to the left by the given amount.

      Parameters

      • numBits: number | Long

        Number of bits

      Returns Long

      Shifted Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shiftRight

shiftRight: ((numBits: number | Long) => Long)

Type declaration

    • (numBits): Long

    • Returns this Long with bits arithmetically shifted to the right by the given amount.

      Parameters

      • numBits: number | Long

        Number of bits

      Returns Long

      Shifted Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shiftRightUnsigned

shiftRightUnsigned: ((numBits: number | Long) => Long)

Type declaration

    • (numBits): Long

    • Returns this Long with bits logically shifted to the right by the given amount.

      Parameters

      • numBits: number | Long

        Number of bits

      Returns Long

      Shifted Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shl

shl: ((numBits: number | Long) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shr

shr: ((numBits: number | Long) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shr_u

shr_u: ((numBits: number | Long) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

shru

shru: ((numBits: number | Long) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

sub

sub: ((subtrahend:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

subtract

subtract: ((subtrahend:
    | string
    | number
    | Long
    | Timestamp) => Long)

Type declaration

    • (subtrahend): Long

    • Returns the difference of this and the specified Long.

      Parameters

      • subtrahend:
            | string
            | number
            | Long
            | Timestamp

        Subtrahend

      Returns Long

      Difference

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

toBigInt

toBigInt: (() => bigint)

Type declaration

    • (): bigint

    • Converts the Long to a BigInt (arbitrary precision).

      Returns bigint

toBytes

toBytes: ((le?: boolean) => number[])

Type declaration

    • (le?): number[]

    • Converts this Long to its byte representation.

      Parameters

      • Optionalle: boolean

        Whether little or big endian, defaults to big endian

      Returns number[]

      Byte representation

Deprecated

Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.

toBytesBE

toBytesBE: (() => number[])

Type declaration

    • (): number[]

    • Converts this Long to its big endian byte representation.

      Returns number[]

      Big endian byte representation

Deprecated

Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.

toBytesLE

toBytesLE: (() => number[])

Type declaration

    • (): number[]

    • Converts this Long to its little endian byte representation.

      Returns number[]

      Little endian byte representation

Deprecated

Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.

toInt

toInt: (() => number)

Type declaration

    • (): number

    • Converts the Long to a 32 bit integer, assuming it is a 32 bit integer.

      Returns number

Deprecated

Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.

toNumber

toNumber: (() => number)

Type declaration

    • (): number

    • Converts the Long to a the nearest floating-point representation of this value (double, 53 bit mantissa).

      Returns number

Deprecated

Not applicable to Timestamp; use .t for seconds since the Unix epoch, or .i for the increment ordinal.

toSigned

toSigned: (() => Long)

Type declaration

    • (): Long

    • Converts this Long to signed.

      Returns Long

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned.

toString

toString: ((radix?: number) => string)

Type declaration

    • (radix?): string

    • Converts the Long to a string written in the specified radix.

      Parameters

      • Optionalradix: number

        Radix (2-36), defaults to 10

      Returns string

      Throws

      RangeError If radix is out of range

toUnsigned

toUnsigned: (() => Long)

Type declaration

    • (): Long

    • Converts this Long to unsigned.

      Returns Long

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned (this is a no-op).

unsigned

unsigned: boolean

Deprecated

Not applicable to Timestamp as the underlying Long is always unsigned (is always true).

xor

xor: ((other: string | number | Long) => Long)

Type declaration

    • (other): Long

    • Returns the bitwise XOR of this Long and the given one.

      Parameters

      • other: string | number | Long

      Returns Long

Deprecated

Not applicable to Timestamp; Timestamp is not intended to be used as a Long.

Static ReadonlyMAX_VALUE

MAX_VALUE: Long

Deprecated

Use Long.MAX_UNSIGNED_VALUE instead.

Accessors

_bsontype

  • get _bsontype(): "Timestamp"

  • Returns "Timestamp"

[bsonType]

  • get [bsonType](): "Timestamp"

  • Returns "Timestamp"

i

  • get i(): number

  • An incrementing ordinal for operations within a given second.

    Returns number

t

  • get t(): number

  • A time_t value measuring seconds since the Unix epoch

    Returns number

Methods

inspect

  • inspect(depth?, options?, inspect?): string

  • Parameters

    • Optionaldepth: number
    • Optionaloptions: unknown
    • Optionalinspect: InspectFn

    Returns string

toJSON

  • toJSON(): {
        $timestamp: string;
    }

  • Returns {
        $timestamp: string;
    }

    • $timestamp: string

StaticfromBits

  • fromBits(lowBits, highBits): Timestamp

  • Returns a Timestamp for the given high and low bits. Each is assumed to use 32 bits.

    Parameters

    • lowBits: number

      the low 32-bits.

    • highBits: number

      the high 32-bits.

    Returns Timestamp

StaticfromInt

  • fromInt(value): Timestamp

  • Returns a Timestamp represented by the given (32-bit) integer value.

    Parameters

    • value: number

    Returns Timestamp

    Deprecated

    Stores value in the low 32 bits (increment), leaving t = 0. Use new Timestamp({ t, i }) or Timestamp.fromBits(lowBits, highBits) for explicit construction.

StaticfromNumber

  • fromNumber(value): Timestamp

  • Returns a Timestamp representing the given number value, provided that it is a finite number. Otherwise, zero is returned.

    Parameters

    • value: number

    Returns Timestamp

    Deprecated

    Splits value across (t, i) as a uint64; the result rarely matches user intent. Use new Timestamp({ t, i }) or Timestamp.fromBits(lowBits, highBits) for explicit construction.

StaticfromString

  • fromString(str, optRadix): Timestamp

  • Returns a Timestamp from the given string, optionally using the given radix.

    Parameters

    • str: string

      the textual representation of the Timestamp.

    • optRadix: number

      the radix in which the text is written.

    Returns Timestamp

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods