Skip to main content
Module

x/denodb/deps.ts>Bson.ObjectId

MySQL, SQLite, MariaDB, PostgreSQL and MongoDB ORM for Deno
Latest
class Bson.ObjectId
import { Bson } from "https://deno.land/x/denodb@v1.4.0/deps.ts";
const { ObjectId } = Bson;

A class representation of the BSON ObjectId type.

Constructors

new
ObjectId(id?:
| string
| Buffer
| number
)

Create an ObjectId type

Properties

_bsontype: "ObjectId"
generationTime: number
id: Buffer

Methods

equals(otherId: string | ObjectId | ObjectIdLike): boolean

Compares the equality of this ObjectId with otherID.

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

inspect(): string
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(format?: string): string

Converts the id into a 24 character hex string for printing

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): Buffer

Generate a 12 byte id buffer used in ObjectId's

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

Checks if a value is a valid bson ObjectId