Class ObjectId

constructor

• new ObjectId(): ObjectId

  To generate a new ObjectId, use ObjectId() with no argument.

  Returns ObjectId
• new ObjectId(inputId: string): ObjectId

  Create ObjectId from a 24 character hex string.

  Parameters

  • inputId: string

    A 24 character hex string.

  Returns ObjectId
• new ObjectId(inputId: ObjectId): ObjectId

  Create ObjectId from the BSON ObjectId type.

  Parameters

  • inputId: ObjectId

    The BSON ObjectId type.

  Returns ObjectId
• new ObjectId(inputId: ObjectIdLike): ObjectId

  Create ObjectId from the object type that has the toHexString method.

  Parameters

  • inputId: ObjectIdLike

    The ObjectIdLike type.

  Returns ObjectId
• new ObjectId(inputId: Uint8Array): ObjectId

  Create ObjectId from a 12 byte binary Buffer.

  Parameters

  • inputId: Uint8Array

    A 12 byte binary Buffer.

  Returns ObjectId
• new ObjectId(
      inputId?: string | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike,
  ): ObjectId

  Implementation overload.

  Parameters

  • OptionalinputId: string | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike

    All input types that are used in the constructor implementation.

  Returns ObjectId

StaticcacheHexString

_bsontype

• get _bsontype(): "ObjectId"

  Returns "ObjectId"

id

• get id(): Uint8Array

  The ObjectId bytes

  Returns Uint8Array

equals

• equals(otherId: undefined | null | string | ObjectId | ObjectIdLike): boolean

  Compares the equality of this ObjectId with otherID.

  Parameters

  • otherId: undefined | null | string | ObjectId | ObjectIdLike

    ObjectId instance to compare against.

  Returns boolean

getTimestamp

• getTimestamp(): Date

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

  Returns Date

inspect

• inspect(depth?: number, options?: unknown, inspect?: InspectFn): string

  Converts to a string representation of this Id.

  Parameters

  • Optionaldepth: number
  • Optionaloptions: unknown
  • Optionalinspect: InspectFn

  Returns string

  return the 24 character hex string representation.

toHexString

• toHexString(): string

  Returns the ObjectId id as a 24 lowercase character hex string representation

  Returns string

toJSON

• toJSON(): string

  Converts to its JSON the 24 character hex string representation.

  Returns string

toString

• toString(encoding?: "hex" | "base64"): string

  Converts the id into a 24 character hex string for printing, unless encoding is provided.

  Parameters

  • Optionalencoding: "hex" | "base64"

    hex or base64

  Returns string

StaticcreateFromBase64

• createFromBase64(base64: string): ObjectId

  Creates an ObjectId instance from a base64 string

  Parameters

  • base64: string

  Returns ObjectId

StaticcreateFromHexString

• createFromHexString(hexString: string): ObjectId

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

  Parameters

  • hexString: string

    create a ObjectId from a passed in 24 character hexstring.

  Returns ObjectId

StaticcreateFromTime

• 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.

  Parameters

  • time: number

    an integer number representing a number of seconds.

  Returns ObjectId

Staticgenerate

• generate(time?: number): Uint8Array

  Generate a 12 byte id buffer used in ObjectId's

  Parameters

  • Optionaltime: number

    pass in a second based timestamp.

  Returns Uint8Array

StaticisValid

• isValid(
      id: string | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike,
  ): boolean

  Checks if a value can be used to create a valid bson ObjectId

  Parameters

  • id: string | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike

    any JS value

  Returns boolean