Interface PlaybookBody<I, P, E, PA, V>

Declarative playbook body (3rd argument to PlaybookDefinition).

interface PlaybookBody<
    I extends Record<string, Column> = Record<string, Column>,
    P extends string | undefined = undefined,
    E extends string | undefined = undefined,
    PA extends boolean | undefined = undefined,
    V extends
        Record<string, VariantDefinition> = Record<string, VariantDefinition>,
> {
    lanes: (
        params: PlaybookBodyParams<I, P, E, V>,
    ) => Record<string, PlaybookBodyEntry<PA>>;
}

I extends Record<string, Column> = Record<string, Column>
Playbook input columns (inferred from declarations)
P extends string | undefined = undefined
Parent table name, when parentTable is set
E extends string | undefined = undefined
The playbook's executionType, which controls what params exposes
PA extends boolean | undefined = undefined
The playbook's publicAccess flag. When true, every lane and activity returned by lanes must be public-safe; TypeScript reports the offending lane or activity as the property that fails to satisfy __publicSafe: true.
V extends Record<string, VariantDefinition> = Record<string, VariantDefinition>

Properties

lanes: (
params: PlaybookBodyParams<I, P, E, V>,
) => Record<string, PlaybookBodyEntry<PA>>

Lane definitions keyed by lane name