Params

Params<TItemName, TData>: object

Defined in: packages/runtime-core/lib/types/instrument.series.d.ts:20

Type Parameters

• TItemName extends string = string

• TData = any

Type declaration

completionMessage()?

optional completionMessage: (this, context) => CompletionMessage | null | undefined

Returns a custom localized CompletionMessage to show on the series completion screen, or null/undefined to use the default. context.terminated indicates whether the series ended early via terminate, allowing a distinct message per outcome.

Parameters

this

void

context

CompletionContext<TItemName>

Returns

CompletionMessage | null | undefined

skipProgress?

optional skipProgress: boolean

terminate()?

optional terminate: (this, data, context) => boolean

Called after each item is submitted with that item’s data and its { itemIndex, itemName }. Return true to end the series early. When authored via defineSeriesInstrument, itemName is narrowed to the literal union of the series’ item names. data defaults to any; annotate the parameter (or pass TData) to type it as the terminating item’s data shape.

Parameters

this

void

data

TData

context

TerminateContext<TItemName>

Returns

boolean