Interface IMongoObjectIdCtor

The driver ObjectId constructor shape.

Since

0.2.0

interface IMongoObjectIdCtor {
new IMongoObjectIdCtor(value?: string): IMongoObjectId;
isValid(value: unknown): boolean;
}

Index

Constructors

Methods

Constructors

constructor

new IMongoObjectIdCtor(value?: string): IMongoObjectId
Constructs a new ObjectId.
Parameters
- Optionalvalue: string
  A 24-hex string (or no argument, for a fresh random id)
Returns IMongoObjectId
- Defined in packages/database-plugin/src/adapters/mongo/mongo-client-types.ts:47

Methods

isValid

isValid(value: unknown): boolean
Tests whether a value is a valid ObjectId — exactly a 24-hex string, so a 12-char value is rejected.
Parameters
- value: unknown
  The candidate value
Returns boolean
- Defined in packages/database-plugin/src/adapters/mongo/mongo-client-types.ts:40