stratadb / DocumentInput

Type Alias: DocumentInput<T>

type DocumentInput<T> = Simplify<SetOptional<Except<T, "_id">, never> & object>;

Defined in: src/core-types.ts:93

Document input type for insertion operations.

Type Parameters

T

T extends Document

The full document type (Document<YourShape>)

Remarks

All fields from the document type are required except for the ID. The ID is optional - if omitted, a unique ID will be auto-generated. This type is used for insertOne() and insertMany() operations.

Example

type User = Document<{
  name: string;
  email: string;
  age: number;
}>;

const userInput: DocumentInput<User> = {
  name: 'Alice',
  email: 'alice@example.com',
  age: 30
  // id is optional
};

await users.insertOne(userInput);