Class Timestamp

Hierarchy

LongWithoutOverridesClass
- Timestamp

Index

Constructors

constructor

new Timestamp(int): Timestamp
Parameters
- int: bigint
  
  A 64-bit bigint representing the Timestamp.
Returns Timestamp
Overrides LongWithoutOverridesClass.constructor
- Defined in node_modules/bson/bson.d.ts:1216
new Timestamp(long): Timestamp
Parameters
- long: Long
  
  A 64-bit Long representing the Timestamp.
Returns Timestamp
Overrides LongWithoutOverridesClass.constructor
- Defined in node_modules/bson/bson.d.ts:1220
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
Overrides LongWithoutOverridesClass.constructor
- Defined in node_modules/bson/bson.d.ts:1224

Properties

isLong

__isLong__: boolean

add

add: ((addend) => Long)

Type declaration

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

and

and: ((other) => Long)

Type declaration

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

comp

comp: ((other) => 0 | 1 | -1)

Type declaration

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

compare

compare: ((other) => 0 | 1 | -1)

Type declaration

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

div

div: ((divisor) => Long)

Type declaration

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

divide

divide: ((divisor) => 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

eq

eq: ((other) => boolean)

Type declaration

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

equals

equals: ((other) => 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 isZero
  
  Returns boolean

ge

ge: ((other) => boolean)

Type declaration

- (other): boolean
- This is an alias of greaterThanOrEqual
  Parameters
  - other: string | number | Long | Timestamp
  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) => 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) => 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) => boolean)

Type declaration

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

gte

gte: ((other) => boolean)

Type declaration

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

high

high: number

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

le

le: ((other) => boolean)

Type declaration

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

lessThan

lessThan: ((other) => 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) => 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

lt

lt: ((other) => boolean)

Type declaration

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

lte

lte: ((other) => boolean)

Type declaration

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

mod

mod: ((divisor) => Long)

Type declaration

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

modulo

modulo: ((divisor) => Long)

Type declaration

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

mul

mul: ((multiplier) => Long)

Type declaration

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

multiply

multiply: ((multiplier) => Long)

Type declaration

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

ne

ne: ((other) => boolean)

Type declaration

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

neg

neg: (() => Long)

Type declaration

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

negate

negate: (() => Long)

Type declaration

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

neq

neq: ((other) => boolean)

Type declaration

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

not

not: (() => Long)

Type declaration

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

notEquals

notEquals: ((other) => 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) => Long)

Type declaration

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

rem

rem: ((divisor) => Long)

Type declaration

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

shiftLeft

shiftLeft: ((numBits) => 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

shiftRight

shiftRight: ((numBits) => 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

shiftRightUnsigned

shiftRightUnsigned: ((numBits) => 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

shl

shl: ((numBits) => Long)

Type declaration

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

shr

shr: ((numBits) => Long)

Type declaration

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

shr_u

shr_u: ((numBits) => Long)

Type declaration

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

shru

shru: ((numBits) => Long)

Type declaration

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

sub

sub: ((subtrahend) => Long)

Type declaration

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

subtract

subtract: ((subtrahend) => Long)

Type declaration

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

toBigInt

toBigInt: (() => bigint)

Type declaration

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

toBytes

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

Type declaration

- (le?): 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

toBytesBE

toBytesBE: (() => number[])

Type declaration

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

toBytesLE

toBytesLE: (() => number[])

Type declaration

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

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

toSigned

toSigned: (() => Long)

Type declaration

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

toString

toString: ((radix?) => string)

Type declaration

- (radix?): string
- Converts the Long to a string written in the specified radix.
  Parameters
  - Optional radix: 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

unsigned

unsigned: boolean

xor

xor: ((other) => Long)

Type declaration

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

`Static` `Readonly` MAX_VALUE

MAX_VALUE: Long

Accessors

_bsontype

get _bsontype(): "Timestamp"
Returns "Timestamp"
- Defined in node_modules/bson/bson.d.ts:1211

Methods

inspect

inspect(depth?, options?, inspect?): string
Parameters
- Optional depth: number
- Optional options: unknown
- Optional inspect: InspectFn
Returns string
- Defined in node_modules/bson/bson.d.ts:1251

toJSON

toJSON(): {
$timestamp: string;
}
Returns {
$timestamp: string;
}
- $timestamp: string
- Defined in node_modules/bson/bson.d.ts:1228

`Static` fromBits

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

`Static` fromInt

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

`Static` fromNumber

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

`Static` fromString

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

Class Timestamp

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

int: bigint

Returns Timestamp

Parameters

long: Long

Returns Timestamp

Parameters

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

i: number

t: number

Returns Timestamp

Properties

__isLong__

add

Type declaration

Parameters

addend: string | number | Long | Timestamp

Returns Long

and

Type declaration

Parameters

other: string | number | Long | Timestamp

Returns Long

comp

Type declaration

Parameters

other: string | number | Long | Timestamp

Returns 0 | 1 | -1

compare

Type declaration

Parameters

other: string | number | Long | Timestamp

Returns 0 | 1 | -1

div

Type declaration

Parameters

divisor: string | number | Long | Timestamp

Returns Long

divide

Type declaration

Parameters

divisor: string | number | Long | Timestamp

Returns Long

eq

Type declaration

Parameters

other: string | number | Long | Timestamp

Returns boolean

equals

Type declaration

Parameters

other: string | number | Long | Timestamp

Returns boolean

eqz

Type declaration

Returns boolean

ge

Type declaration

Parameters

other: string | number | Long | Timestamp

Returns boolean

getHighBits

Type declaration

Returns number

getHighBitsUnsigned

Type declaration

Returns number

getLowBits

Type declaration

Returns number

getLowBitsUnsigned

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

isLong