Skip to main content
Module

x/denomongo_unittest_utils/deps.ts>Bson.ObjectId

Unittest utilities for deno_mongo
Gang-of-Fork/denomongo-unittest-utils
Latest
class Bson.ObjectId
Re-export
import { Bson } from "https://deno.land/x/denomongo_unittest_utils@v0.5.3/deps.ts";
const { ObjectId } = Bson;

A class representation of the BSON ObjectId type.

Constructors

new
ObjectId(inputId?:
| string
| number
| Uint8Array
)

Create an ObjectId type

Properties

id: Uint8Array

The ObjectId bytes

Methods

equals(otherId: string | ObjectId): boolean

Compares the equality of this ObjectId with otherID.

getTimestamp(): Date

Returns the generation date (accurate up to the second) that this ID was generated.

toHexString(): string

Returns the ObjectId id as a 24 character hex string representation

toJSON(): string

Converts to its JSON the 24 character hex string representation.

toString(): string

Converts the id into a 24 character hex string for printing

[Symbol.for("Deno.customInspect")](): string

Static Properties

cacheHexString: boolean

Static Methods

createFromHexString(hexString: string): ObjectId

Creates an ObjectId from a hex string representation of an ObjectId.

createFromTime(time: number): ObjectId

Creates an ObjectId from a second based number, with the rest of the ObjectId zeroed out. Used for comparisons or sorting the ObjectId.

generate(time?: number): Uint8Array

Generate a 12 byte id buffer used in ObjectId's

isValid(id:
| string
| number
| Uint8Array
): boolean

Checks if a value is a valid bson ObjectId