IDateOptions

interface
Date & Time

Plugin-level date configuration passed to createOrigam({ date: … }). Specifies the adapter class or instance, optional format overrides, and locale maps.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

adapter
required
(new (options: { locale: any, formats?: any }) => IDateInstance) | IDateInstance
The date adapter — either a constructor class or an already-instantiated adapter.
formats
Record<string, any>
Optional display-format overrides keyed by format name (e.g. "keyboardDate").
locale
required
Record<string, any>
Locale map used by the adapter to resolve date locale strings.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Providing IDateOptions at plugin install

typescript