Skip to content

Factory Functions

Factory functions are used to create temporal instances.

Core Factory Function

createTemporal

Creates a new temporal instance with date adapter and configuration.

typescript
import { createTemporal } from '@allystudio/usetemporal'
import { createNativeAdapter } from '@allystudio/usetemporal/native'

const temporal = createTemporal({
  date: new Date(),
  adapter: createNativeAdapter(),
  weekStartsOn: 1 // Monday
})

Usage Examples

typescript
import { createTemporal } from '@allystudio/usetemporal'
import { createNativeAdapter } from '@allystudio/usetemporal/native'

// Create temporal instance with native adapter
const temporal = createTemporal({
  date: new Date(),
  adapter: createNativeAdapter()
})

// Create temporal instance with custom week start
const temporalWithMonday = createTemporal({
  date: new Date(),
  adapter: createNativeAdapter(),
  weekStartsOn: 1
})

See Also

Released under the MIT License.