Timestamp | Documentation

Hierarchy

LongWithoutOverridesClass
- Timestamp

Properties

_bsontype

_bsontype: "Timestamp"

Static Readonly MAX_VALUE

MAX_VALUE: Long

sub

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

Type declaration

- (subtrahend: string | number | Timestamp | Long): Long
- This is an alias of Long.subtract
  
  Parameters
  - subtrahend: string | number | Timestamp | Long
  Returns Long

compare

Type declaration

- (other: string | number | Timestamp | Long): 0 | 1 | -1
- Compares this Long's value with the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns 0 | 1 | -1
  0 if they are the same, 1 if the this is greater and -1 if the given one is greater

equals

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- Tests if this Long's value equals the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
    
    Other value
  Returns boolean

isLong

__isLong__: true

high

high: number

low

low: number

unsigned

unsigned: boolean

add

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

Type declaration

- (addend: string | number | Timestamp | Long): Long
- Returns the sum of this and the specified Long.
  
  Parameters
  - addend: string | number | Timestamp | Long
  Returns Long

and

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

Type declaration

- (other: string | number | Timestamp | Long): Long
- Returns the sum of this and the specified Long.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns Long
  Sum

comp

Type declaration

- (other: string | number | Timestamp | Long): 0 | 1 | -1
- This is an alias of Long.compare
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns 0 | 1 | -1

divide

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

Type declaration

- (divisor: string | number | Timestamp | Long): 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 | Timestamp | Long
  Returns Long
  Quotient

div

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

Type declaration

- (divisor: string | number | Timestamp | Long): Long
- This is an alias of Long.divide
  
  Parameters
  - divisor: string | number | Timestamp | Long
  Returns Long

eq

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.equals
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

getHighBits

getHighBits: (() => number)

Type declaration

- (): number
- Gets the high 32 bits as a signed integer.
  
  Returns number

getHighBitsUnsigned

getHighBitsUnsigned: (() => number)

Type declaration

- (): number
- Gets the high 32 bits as an unsigned integer.
  
  Returns number

getLowBits

getLowBits: (() => number)

Type declaration

- (): number
- Gets the low 32 bits as a signed integer.
  
  Returns number

getLowBitsUnsigned

getLowBitsUnsigned: (() => number)

Type declaration

- (): number
- Gets the low 32 bits as an unsigned integer.
  
  Returns number

getNumBitsAbs

getNumBitsAbs: (() => number)

Type declaration

- (): number
- Gets the number of bits needed to represent the absolute value of this Long.
  
  Returns number

greaterThan

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- Tests if this Long's value is greater than the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

gt

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.greaterThan
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

greaterThanOrEqual

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- Tests if this Long's value is greater than or equal the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

gte

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.greaterThanOrEqual
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

ge

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.greaterThanOrEqual
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

isEven

isEven: (() => boolean)

Type declaration

- (): boolean
- Tests if this Long's value is even.
  
  Returns boolean

isNegative

isNegative: (() => boolean)

Type declaration

- (): boolean
- Tests if this Long's value is negative.
  
  Returns boolean

isOdd

isOdd: (() => boolean)

Type declaration

- (): boolean
- Tests if this Long's value is odd.
  
  Returns boolean

isPositive

isPositive: (() => boolean)

Type declaration

- (): boolean
- Tests if this Long's value is positive.
  
  Returns boolean

isZero

isZero: (() => boolean)

Type declaration

- (): boolean
- Tests if this Long's value equals zero.
  
  Returns boolean

lessThan

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- Tests if this Long's value is less than the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

lt

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of {@link Long#lessThan}.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

lessThanOrEqual

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- Tests if this Long's value is less than or equal the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

lte

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.lessThanOrEqual
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

modulo

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

Type declaration

- (divisor: string | number | Timestamp | Long): Long
- Returns this Long modulo the specified.
  
  Parameters
  - divisor: string | number | Timestamp | Long
  Returns Long

mod

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

Type declaration

- (divisor: string | number | Timestamp | Long): Long
- This is an alias of Long.modulo
  
  Parameters
  - divisor: string | number | Timestamp | Long
  Returns Long

rem

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

Type declaration

- (divisor: string | number | Timestamp | Long): Long
- This is an alias of Long.modulo
  
  Parameters
  - divisor: string | number | Timestamp | Long
  Returns Long

multiply

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

Type declaration

- (multiplier: string | number | Timestamp | Long): Long
- Returns the product of this and the specified Long.
  
  Parameters
  - multiplier: string | number | Timestamp | Long
    
    Multiplier
  Returns Long
  Product

mul

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

Type declaration

- (multiplier: string | number | Timestamp | Long): Long
- This is an alias of Long.multiply
  
  Parameters
  - multiplier: string | number | Timestamp | Long
  Returns Long

negate

negate: (() => Long)

Type declaration

- (): Long
- Returns the Negation of this Long's value.
  
  Returns Long

neg

neg: (() => Long)

Type declaration

- (): Long
- This is an alias of Long.negate
  
  Returns Long

not

not: (() => Long)

Type declaration

- (): Long
- Returns the bitwise NOT of this Long.
  
  Returns Long

notEquals

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- Tests if this Long's value differs from the specified's.
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

neq

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.notEquals
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

ne

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.notEquals
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

or

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

Type declaration

- (other: string | number | Long): Long
- Returns the bitwise OR of this Long and the specified.
  
  Parameters
  - other: string | number | Long
  Returns Long

shiftLeft

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

Type declaration

- (numBits: number | Long): 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

shl

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

Type declaration

- (numBits: number | Long): Long
- This is an alias of Long.shiftLeft
  
  Parameters
  - numBits: number | Long
  Returns Long

shiftRight

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

Type declaration

- (numBits: number | Long): 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

shr

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

Type declaration

- (numBits: number | Long): Long
- This is an alias of Long.shiftRight
  
  Parameters
  - numBits: number | Long
  Returns Long

shiftRightUnsigned

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

Type declaration

- (numBits: number | Long): 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

shr_u

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

Type declaration

- (numBits: number | Long): Long
- This is an alias of Long.shiftRightUnsigned
  
  Parameters
  - numBits: number | Long
  Returns Long

shru

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

Type declaration

- (numBits: number | Long): Long
- This is an alias of Long.shiftRightUnsigned
  
  Parameters
  - numBits: number | Long
  Returns Long

subtract

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

Type declaration

- (subtrahend: string | number | Timestamp | Long): Long
- Returns the difference of this and the specified Long.
  
  Parameters
  - subtrahend: string | number | Timestamp | Long
    
    Subtrahend
  Returns Long
  Difference

toInt

toInt: (() => number)

Type declaration

- (): number
- Converts the Long to a 32 bit integer, assuming it is a 32 bit integer.
  
  Returns number

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

toBigInt

toBigInt: (() => bigint)

Type declaration

- (): bigint
- Converts the Long to a BigInt (arbitrary precision).
  
  Returns bigint

toBytes

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

Type declaration

- (le?: boolean): number[]
- Converts this Long to its byte representation.
  
  Parameters
  - Optional le: boolean
    
    Whether little or big endian, defaults to big endian
  Returns number[]
  Byte representation

toBytesLE

toBytesLE: (() => number[])

Type declaration

- (): number[]
- Converts this Long to its little endian byte representation.
  
  Returns number[]
  Little endian byte representation

toBytesBE

toBytesBE: (() => number[])

Type declaration

- (): number[]
- Converts this Long to its big endian byte representation.
  
  Returns number[]
  Big endian byte representation

toSigned

toSigned: (() => Long)

Type declaration

- (): Long
- Converts this Long to signed.
  
  Returns Long

toUnsigned

toUnsigned: (() => Long)

Type declaration

- (): Long
- Converts this Long to unsigned.
  
  Returns Long

xor

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

Type declaration

- (other: string | number | Long): Long
- Returns the bitwise XOR of this Long and the given one.
  
  Parameters
  - other: string | number | Long
  Returns Long

eqz

eqz: (() => boolean)

Type declaration

- (): boolean
- This is an alias of Long.isZero
  
  Returns boolean

le

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

Type declaration

- (other: string | number | Timestamp | Long): boolean
- This is an alias of Long.lessThanOrEqual
  
  Parameters
  - other: string | number | Timestamp | Long
  Returns boolean

Constructors

constructor

new Timestamp(long: Long): Timestamp
new Timestamp(value: { t: number; i: number }): Timestamp
new Timestamp(low: number, high: number): Timestamp

Overrides LongWithoutOverridesClass.constructor
- Defined in node_modules/bson/bson.d.ts:1112
Parameters
- long: Long
Returns Timestamp
Overrides LongWithoutOverridesClass.constructor
- Defined in node_modules/bson/bson.d.ts:1116
Parameters
- value: { t: number; i: number }
  
  A pair of two values indicating timestamp and increment.
  - t: number
  - i: number
Returns Timestamp
Overrides LongWithoutOverridesClass.constructor
- Defined in node_modules/bson/bson.d.ts:1125
deprecated
Please use Timestamp({ t: high, i: low }) or Timestamp(Long(low, high)) instead.

Parameters
- low: number
  
  the low (signed) 32 bits of the Timestamp.
- high: number
  
  the high (signed) 32 bits of the Timestamp.
Returns Timestamp

Methods

toJSON

toJSON(): { $timestamp: string }

- Defined in node_modules/bson/bson.d.ts:1126
Returns { $timestamp: string }
- $timestamp: string

Static fromInt

fromInt(value: number): Timestamp

- Defined in node_modules/bson/bson.d.ts:1130
Returns a Timestamp represented by the given (32-bit) integer value.

Parameters
- value: number
Returns Timestamp

Static fromNumber

fromNumber(value: number): Timestamp

- Defined in node_modules/bson/bson.d.ts:1132
Returns a Timestamp representing the given number value, provided that it is a finite number. Otherwise, zero is returned.

Parameters
- value: number
Returns Timestamp

Static fromBits

fromBits(lowBits: number, highBits: number): Timestamp

- Defined in node_modules/bson/bson.d.ts:1139
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

Static fromString

fromString(str: string, optRadix: number): Timestamp

- Defined in node_modules/bson/bson.d.ts:1146
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

inspect

inspect(): string

- Defined in node_modules/bson/bson.d.ts:1149
Returns string

toString

toString(radix?: number): string

Inherited from LongWithoutOverridesClass.toString
- Defined in node_modules/typescript/lib/lib.es5.d.ts:127
Returns a string representation of an object.

Parameters
- Optional radix: number
Returns string

Hierarchy

Index

Properties

Constructors

Methods

Properties

_bsontype

Static Readonly MAX_VALUE

sub

Type declaration

Parameters

subtrahend: string | number | Timestamp | Long

Returns Long

compare

Type declaration

Parameters

other: string | number | Timestamp | Long

Returns 0 | 1 | -1

equals

Type declaration

Parameters

other: string | number | Timestamp | Long

Returns boolean

__isLong__

high

low

unsigned

add

Type declaration

Parameters

addend: string | number | Timestamp | Long

Returns Long

and

Type declaration

Parameters

other: string | number | Timestamp | Long

Returns Long

comp

Type declaration

Parameters

other: string | number | Timestamp | Long

Returns 0 | 1 | -1

divide

Type declaration

Parameters

divisor: string | number | Timestamp | Long

Returns Long

div

Type declaration

Parameters

divisor: string | number | Timestamp | Long

Returns Long

eq

Type declaration

Parameters

other: string | number | Timestamp | Long

Returns boolean

getHighBits

Type declaration

Returns number

getHighBitsUnsigned

Type declaration

Returns number

getLowBits

Type declaration

Returns number

getLowBitsUnsigned

Type declaration

Returns number

getNumBitsAbs

Type declaration

Returns number

greaterThan

Type declaration

Parameters

other: string | number | Timestamp | Long

Returns boolean

gt

Type declaration

Parameters

isLong