Intent

import { Intent, Intents } from '@hurum/core'

Intent(...commands)

Creates a sequential intent. Commands execute one after another. If any executor throws, subsequent commands are skipped.

Signature

function Intent<TInput>(...commands: Command<TInput>[]): IntentAction<TInput>

Parameters

Parameter	Type	Description
...commands	Command<TInput>[]	One or more commands to execute in order.

Returns

An IntentAction<TInput> — both an intent descriptor and a callable function.

Example

const PurchaseIntents = Intents('Purchase', {
  submitClicked: Intent(ValidateCmd, SaveCmd),
  pageOpened: Intent(LoadCmd),
})

---

Intent.all(...commands)

Creates a parallel, fail-fast intent. All commands start simultaneously. If one fails, the others are aborted via their AbortSignal.

Signature

Intent.all<TInput>(...commands: Command<TInput>[]): IntentAction<TInput>

Example

const DashboardIntents = Intents('Dashboard', {
  pageOpened: Intent.all(LoadUserCmd, LoadStatsCmd, LoadNotificationsCmd),
})

---

Intent.allSettled(...commands)

Creates a parallel, independent intent. All commands start simultaneously. Each runs to completion independently — a failure in one does not affect the others.

Signature

Intent.allSettled<TInput>(...commands: Command<TInput>[]): IntentAction<TInput>

Example

const SyncIntents = Intents('Sync', {
  syncAll: Intent.allSettled(SyncContactsCmd, SyncCalendarCmd, SyncFilesCmd),
})

---

Intents(prefix, definitions)

Creates a namespaced container of intents. The container is passed to Store.intents() to register intent actions on the store.

Signature

function Intents<TPrefix extends string, TDefs extends Record<string, IntentDescriptor>>(
  prefix: TPrefix,
  intents: TDefs,
): TDefs & IntentsContainer

Parameters

Parameter	Type	Description
prefix	string	Namespace prefix for identification.
intents	Record<string, IntentDescriptor>	A map of intent names to Intent(...) definitions.

Returns

An IntentsContainer with the same keys as intents. Each value is an IntentAction.

Example

const CartIntents = Intents('Cart', {
  addItem: Intent(AddItemCmd),
  checkout: Intent(ValidateCartCmd, ProcessPaymentCmd, ConfirmOrderCmd),
  refreshPrices: Intent.all(FetchPriceCmd, FetchTaxCmd),
})

---

IntentAction<TInput>

The type of each intent produced by Intent(...). It is both an IntentDescriptor and a callable function.

Properties

Property	Type	Description
commands	ReadonlyArray<Command<TInput>>	The commands this intent will execute.
mode	'sequential' | 'all' | 'allSettled'	The execution strategy.

Call Signature

(payload: TInput) => PreparedIntent<TInput>

Calling an IntentAction with a payload produces a PreparedIntent ready for store.send().

Example

// Create a PreparedIntent
const prepared = CartIntents.addItem({ item: newItem })

// Send it
store.send(prepared)

// Or use the shorthand (equivalent)
store.send.addItem({ item: newItem })

---

PreparedIntent<TInput>

An intent paired with its payload, ready to be dispatched. Created by calling an IntentAction with a payload.

Properties

Property	Type	Description
intent	IntentDescriptor<TInput>	The original intent descriptor.
payload	TInput	The payload to pass to each executor.

---

IntentRef

An opaque reference returned by store.send(). Used for cancellation.

const ref = store.send.submitClicked({ formData })

// Cancel this specific intent
store.cancel(ref)

---

Execution Modes Summary

Mode	Function	Behavior on Failure
Sequential	Intent(A, B, C)	Stops at the failing command. B and C are skipped.
Parallel fail-fast	Intent.all(A, B, C)	Aborts all others via AbortSignal.
Parallel independent	Intent.allSettled(A, B, C)	Other commands continue. Error is reported via middleware.

---

Notes

• Intents represent user actions or system triggers (“submit clicked”, “page opened”). Name them from the user’s perspective.
• The payload type TInput is shared across all commands in an intent. Every executor in the chain receives the same payload.
• Use Intent() (sequential) as the default. Switch to Intent.all() or Intent.allSettled() only when parallel execution is needed.