类 ObjectId

constructor

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

  Create an ObjectId type

  参数

  • 可选inputId: string | number | ObjectId | Uint8Array<ArrayBufferLike> | ObjectIdLike

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

  返回 ObjectId

静态cacheHexString

_bsontype

• get _bsontype(): "ObjectId"

  返回 "ObjectId"

id

• get id(): Uint8Array

  The ObjectId bytes

  返回 Uint8Array

equals

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

  Compares the equality of this ObjectId with otherID.

  参数

  • otherId: string | ObjectId | ObjectIdLike

    ObjectId instance to compare against.

  返回 boolean

getTimestamp

• getTimestamp(): Date

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

  返回 Date

inspect

• inspect(): string

  返回 string

toHexString

• toHexString(): string

  Returns the ObjectId id as a 24 character hex string representation

  返回 string

toJSON

• toJSON(): string

  Converts to its JSON the 24 character hex string representation.

  返回 string

toString

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

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

  参数

  • 可选encoding: "base64" | "hex"

    hex or base64

  返回 string

静态createFromBase64

• createFromBase64(base64: string): ObjectId

  Creates an ObjectId instance from a base64 string

  参数

  • base64: string

  返回 ObjectId

静态createFromHexString

• createFromHexString(hexString: string): ObjectId

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

  参数

  • hexString: string

    create a ObjectId from a passed in 24 character hexstring.

  返回 ObjectId

静态createFromTime

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

  参数

  • time: number

    an integer number representing a number of seconds.

  返回 ObjectId

静态generate

• generate(time?: number): Uint8Array

  Generate a 12 byte id buffer used in ObjectId's

  参数

  • 可选time: number

    pass in a second based timestamp.

  返回 Uint8Array

静态isValid

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

  Checks if a value is a valid bson ObjectId

  参数

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

    ObjectId instance to validate.

  返回 boolean