Class Timestamp

Hierarchy (view full)

LongWithoutOverridesClass
- Timestamp

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:1599
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:1603
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:1607

Properties

isLong

__isLong__: boolean

add

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

Type declaration

- (addend): 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): Long
- Returns the sum of this and the specified Long.
  Parameters
  - other:
        | string
        | number
        | Timestamp
        | Long
  Returns Long
  Sum

comp

Type declaration

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

compare

Type declaration

- (other): -1 | 0 | 1
- Compares this Long's value with the specified's.
  Parameters
  - other:
        | string
        | number
        | Timestamp
        | Long
  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
    | Timestamp
    | Long) => Long)

Type declaration

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

divide

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

eq

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

Type declaration

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

equals

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

Type declaration

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

eqz

eqz: (() => boolean)

Type declaration

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

ge

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

Type declaration

- (other): boolean
- This is an alias of Long.greaterThanOrEqual
  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): boolean
- Tests if this Long's value is greater than the specified's.
  Parameters
  - other:
        | string
        | number
        | Timestamp
        | Long
  Returns boolean

greaterThanOrEqual

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

Type declaration

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

gt

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

Type declaration

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

gte

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

Type declaration

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

Type declaration

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

lessThan

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

Type declaration

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

lessThanOrEqual

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

Type declaration

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

low

low: number

lt

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

Type declaration

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

lte

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

Type declaration

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

mod

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

Type declaration

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

modulo

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

Type declaration

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

mul

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

Type declaration

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

multiply

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

Type declaration

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

ne

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

Type declaration

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

neg

neg: (() => Long)

Type declaration

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

negate

negate: (() => Long)

Type declaration

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

neq

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

Type declaration

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

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): boolean
- Tests if this Long's value differs from the specified's.
  Parameters
  - other:
        | string
        | number
        | Timestamp
        | Long
  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

rem

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

Type declaration

- (divisor): Long
- This is an alias of Long.modulo
  Parameters
  - divisor:
        | string
        | number
        | Timestamp
        | Long
  Returns 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

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

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

shl

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

Type declaration

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

shr

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

Type declaration

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

shr_u

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

Type declaration

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

shru

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

Type declaration

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

sub

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

Type declaration

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

subtract

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

Type declaration

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

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

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?: 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

unsigned

unsigned: boolean

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

`Static` `Readonly`MAX_VALUE

MAX_VALUE: Long

Accessors

_bsontype

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

i

get i(): number
An incrementing ordinal for operations within a given second.

Returns number
- Defined in node_modules/bson/bson.d.ts:1591

t

get t(): number
A time_t value measuring seconds since the Unix epoch

Returns number
- Defined in node_modules/bson/bson.d.ts:1595

Methods

inspect

inspect(depth?, options?, inspect?): string
Parameters
- Optionaldepth: number
- Optionaloptions: unknown
- Optionalinspect: InspectFn
Returns string
- Defined in node_modules/bson/bson.d.ts:1634

toJSON

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

`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:1624

`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:1615

`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:1617

`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:1631

Class Timestamp

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Timestamp

Parameters

Returns Timestamp

Parameters

i: number

t: number

Returns Timestamp

Properties

__isLong__

add

Type declaration

Parameters

Returns Long

and

Type declaration

Parameters

Returns Long

comp

Type declaration

Parameters

Returns -1 | 0 | 1

compare

Type declaration

Parameters

Returns -1 | 0 | 1

div

Type declaration

Parameters

Returns Long

divide

Type declaration

Parameters

Returns Long

eq

Type declaration

Parameters

Returns boolean

equals

Type declaration

Parameters

Returns boolean

eqz

Type declaration

Returns boolean

ge

Type declaration

Parameters

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

Returns boolean

greaterThanOrEqual

Type declaration

Parameters

isLong