stratadb / TimestampConfig

Type Alias: TimestampConfig

type TimestampConfig = 
  | {
  createdAt?: boolean;
  updatedAt?: boolean;
}
  | boolean;

Defined in: src/schema-types.ts:207

Configuration for automatic timestamp management.

Type Declaration

{
  createdAt?: boolean;
  updatedAt?: boolean;
}

createdAt?

readonly optional createdAt: boolean;

Whether to automatically add createdAt timestamp on document creation

updatedAt?

readonly optional updatedAt: boolean;

Whether to automatically update updatedAt timestamp on document modification

boolean

Remarks

Controls whether documents automatically receive createdAt and updatedAt timestamps when inserted or updated. This simplifies audit trail management and is commonly used in document databases.

Example

// Enable both timestamps (default behavior)
const timestamps: TimestampConfig = true;

// Explicit configuration
const timestamps: TimestampConfig = {
  createdAt: true,
  updatedAt: true
};

// Only track creation time
const timestamps: TimestampConfig = {
  createdAt: true,
  updatedAt: false
};

// Disable automatic timestamps
const timestamps: TimestampConfig = false;