Class ObjectID

constructor

• new ObjectID(inputId?): ObjectID

• Create an ObjectId type

  Parameters

  • Optional inputId: string | number | Uint8Array | ObjectID | ObjectIdLike | Buffer

    Can be a 24 character hex string, 12 byte binary Buffer, or a number.

  Returns ObjectID

_bsontype

Static cacheHexString

generationTime

• get generationTime(): number

• The generation time of this ObjectId instance

  Deprecated

  Please use getTimestamp / createFromTime which returns an int32 epoch

  Returns number

• set generationTime(value): void

• Parameters

  • value: number

  Returns void

id

• get id(): Buffer

• The ObjectId bytes

  Returns Buffer

equals

• equals(otherId): boolean

• Compares the equality of this ObjectId with otherID.

  Parameters

  • otherId: 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(): string

• Returns string

toHexString

• toHexString(): string

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

  Returns string

toJSON

• toJSON(): string

• Converts to its JSON the 24 character hex string representation.

  Returns string

toString

• toString(format?): string

• Converts the id into a 24 character hex string for printing

  Parameters

  • Optional format: string

    The Buffer toString format parameter.

  Returns string

Static createFromHexString

• createFromHexString(hexString): 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

Static createFromTime

• createFromTime(time): 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

Static generate

• generate(time?): Buffer

• Generate a 12 byte id buffer used in ObjectId's

  Parameters

  • Optional time: number

    pass in a second based timestamp.

  Returns Buffer

Static isValid

• isValid(id): boolean

• Checks if a value is a valid bson ObjectId

  Parameters

  • id: string | number | Uint8Array | ObjectID | ObjectIdLike | Buffer

    ObjectId instance to validate.

  Returns boolean