Node.js MongoDB Driver API

Class: Timestamp

Timestamp

new Timestamp(low, high)

node_modules/bson/lib/bson/timestamp.js, line 45

This type is for INTERNAL use in MongoDB only and should not be used in applications.
The appropriate corresponding type is the JavaScript Date type.

Defines a Timestamp class for representing a 64-bit two's-complement
integer value, which faithfully simulates the behavior of a Java "Timestamp". This
implementation is derived from TimestampLib in GWT.

Constructs a 64-bit two's-complement integer, given its low and high 32-bit
values as signed integers. See the from* functions below for more
convenient ways of constructing Timestamps.

The internal representation of a Timestamp is the two given signed, 32-bit values.
We use 32-bit pieces because these are the size of integers on which
Javascript performs bit-operations. For operations like addition and
multiplication, we split each number into 16-bit pieces, which can easily be
multiplied within Javascript's floating-point representation without overflow
or change in sign.

In the algorithms below, we frequently reduce the negative case to the
positive case by negating the input(s) and then post-processing the result.
Note that we must ALWAYS check specially whether those values are MIN_VALUE
(-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as
a positive number, it overflows back into a negative). Not handling this
case would often result in infinite recursion.

Name Type Description
low number

the low (signed) 32 bits of the Timestamp.
high number

the high (signed) 32 bits of the Timestamp.

Members

staticTimestamp.MAX_VALUETimestamp

staticTimestamp.MIN_VALUETimestamp

staticTimestamp.NEG_ONETimestamp

staticTimestamp.ONETimestamp

staticTimestamp.ZEROTimestamp

Methods

add(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 345

Returns the sum of this and the given Timestamp.

Name Type Description
other Timestamp

Timestamp to add to this one.
Returns:
sum of this and the given Timestamp.

and(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 570

Returns the bitwise-AND of this Timestamp and the given one.

Name Type Description
other Timestamp

the Timestamp with which to AND.
Returns:
bitwise-AND of this and the other.

compare(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 302

Compares this Timestamp with the given one.

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
if they are the same, 1 if the this is greater, and -1 if the given one is greater.

div(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 464

Returns this Timestamp divided by the given one.

Name Type Description
other Timestamp

Timestamp by which to divide.
Returns:
Timestamp divided by the given one.

equals(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 236

Return whether this Timestamp equals the other

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
this Timestamp equals the other

getHighBits(){number}

node_modules/bson/lib/bson/timestamp.js, line 150

Return the high 32-bits value.

Returns:
high 32-bits as a signed value.

getLowBits(){number}

node_modules/bson/lib/bson/timestamp.js, line 160

Return the low 32-bits value.

Returns:
low 32-bits as a signed value.

getLowBitsUnsigned(){number}

node_modules/bson/lib/bson/timestamp.js, line 170

Return the low unsigned 32-bits value.

Returns:
low 32-bits as an unsigned value.

getNumBitsAbs(){number}

node_modules/bson/lib/bson/timestamp.js, line 181

Returns the number of bits needed to represent the absolute value of this Timestamp.

Returns:
the number of bits needed to represent the absolute value of this Timestamp.

greaterThan(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 280

Return whether this Timestamp is greater than the other.

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
this Timestamp is greater than the other.

greaterThanOrEqual(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 291

Return whether this Timestamp is greater than or equal to the other.

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
this Timestamp is greater than or equal to the other.

isNegative(){boolean}

node_modules/bson/lib/bson/timestamp.js, line 215

Return whether this value is negative.

Returns:
this value is negative.

isOdd(){boolean}

node_modules/bson/lib/bson/timestamp.js, line 225

Return whether this value is odd.

Returns:
this value is odd.

isZero(){boolean}

node_modules/bson/lib/bson/timestamp.js, line 205

Return whether this value is zero.

Returns:
this value is zero.

lessThan(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 258

Return whether this Timestamp is less than the other.

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
this Timestamp is less than the other.

lessThanOrEqual(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 269

Return whether this Timestamp is less than or equal to the other.

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
this Timestamp is less than or equal to the other.

modulo(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 549

Returns this Timestamp modulo the given one.

Name Type Description
other Timestamp

Timestamp by which to mod.
Returns:
Timestamp modulo the given one.

multiply(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 391

Returns the product of this and the given Timestamp.

Name Type Description
other Timestamp

Timestamp to multiply with this.
Returns:
product of this and the other.

negate(){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 330

The negation of this value.

Returns:
negation of this value.

not(){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 559

The bitwise-NOT of this value.

Returns:
bitwise-NOT of this value.

notEquals(other){boolean}

node_modules/bson/lib/bson/timestamp.js, line 247

Return whether this Timestamp does not equal the other.

Name Type Description
other Timestamp

Timestamp to compare against.
Returns:
this Timestamp does not equal the other.

or(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 581

Returns the bitwise-OR of this Timestamp and the given one.

Name Type Description
other Timestamp

the Timestamp with which to OR.
Returns:
bitwise-OR of this and the other.

shiftLeft(numBits){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 603

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

Name Type Description
numBits number

the number of bits by which to shift.
Returns:
shifted to the left by the given amount.

shiftRight(numBits){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 627

Returns this Timestamp with bits shifted to the right by the given amount.

Name Type Description
numBits number

the number of bits by which to shift.
Returns:
shifted to the right by the given amount.

shiftRightUnsigned(numBits){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 653

Returns this Timestamp with bits shifted to the right by the given amount, with the new top bits matching the current sign bit.

Name Type Description
numBits number

the number of bits by which to shift.
Returns:
shifted to the right by the given amount, with zeros placed into the new leading bits.

subtract(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 380

Returns the difference of this and the given Timestamp.

Name Type Description
other Timestamp

Timestamp to subtract from this.
Returns:
difference of this and the given Timestamp.

toInt(){number}

node_modules/bson/lib/bson/timestamp.js, line 66

Return the int value.

Returns:
value, assuming it is a 32-bit integer.

toJSON(){string}

node_modules/bson/lib/bson/timestamp.js, line 87

Return the JSON value.

Returns:
JSON representation.

toNumber(){number}

node_modules/bson/lib/bson/timestamp.js, line 76

Return the Number value.

Returns:
closest floating-point representation to this value.

toString(opt_radix){string}

node_modules/bson/lib/bson/timestamp.js, line 98

Return the String value.

Name Type Description
opt_radix number optional

the radix in which the text should be written.
Returns:
textual representation of this value.

xor(other){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 592

Returns the bitwise-XOR of this Timestamp and the given one.

Name Type Description
other Timestamp

the Timestamp with which to XOR.
Returns:
bitwise-XOR of this and the other.

staticTimestamp.fromBits(lowBits, highBits){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 725

Returns a Timestamp representing the 64-bit integer that comes by concatenating the given high and low bits. Each is assumed to use 32 bits.

Name Type Description
lowBits number

the low 32-bits.
highBits number

the high 32-bits.
Returns:
corresponding Timestamp value.

staticTimestamp.fromInt(value){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 679

Returns a Timestamp representing the given (32-bit) integer value.

Name Type Description
value number

the 32-bit integer in question.
Returns:
corresponding Timestamp value.

staticTimestamp.fromNumber(value){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 701

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

Name Type Description
value number

the number in question.
Returns:
corresponding Timestamp value.

staticTimestamp.fromString(str, opt_radix){Timestamp}

node_modules/bson/lib/bson/timestamp.js, line 737

Returns a Timestamp representation of the given string, written using the given radix.

Name Type Description
str string

the textual representation of the Timestamp.
opt_radix number

the radix in which the text is written.
Returns:
corresponding Timestamp value.
comments powered by Disqus