ObjectId | mongodb (original) (raw)

Hierarchy (view full)

• BSONValue
  • ObjectId

Index

Constructors

constructor

• new ObjectId(inputId): ObjectId

• Parameters

  • inputId: number

Returns ObjectId

• new ObjectId(inputId): ObjectId

• Parameters

  • inputId: string

Returns ObjectId

• new ObjectId(inputId): ObjectId

• Returns ObjectId

• new ObjectId(inputId): ObjectId

• Returns ObjectId

• new ObjectId(inputId): ObjectId

• Parameters

  • inputId: Uint8Array

Returns ObjectId

• new ObjectId(): ObjectId

• Returns ObjectId

• new ObjectId(inputId?): ObjectId

• Returns ObjectId

Properties

StaticcacheHexString

cacheHexString: boolean

Accessors

_bsontype

• get _bsontype(): "ObjectId"

• Returns "ObjectId"

id

• get id(): Uint8Array

• Returns Uint8Array

Methods

equals

• equals(otherId): boolean

• Returns boolean

getTimestamp

• getTimestamp(): Date

• Returns Date

inspect

• inspect(depth?, options?, inspect?): string

• Parameters

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

Returns string

return the 24 character hex string representation.

toHexString

• toHexString(): string

• Returns string

toJSON

• toJSON(): string

• Returns string

toString

• toString(encoding?): string

• Parameters

  • Optionalencoding: "base64" | "hex"

Returns string

StaticcreateFromBase64

• createFromBase64(base64): ObjectId

• Returns ObjectId

StaticcreateFromHexString

• createFromHexString(hexString): ObjectId

• Parameters

  • hexString: string

Returns ObjectId

StaticcreateFromTime

• createFromTime(time): ObjectId

• Returns ObjectId

Staticgenerate

• generate(time?): Uint8Array

• Parameters

  • Optionaltime: number

Returns Uint8Array

StaticisValid

• isValid(id): boolean

• Returns boolean