Skip to main content

@dialstack/sdk / index / OnboardingCollectionOptions

Interface: OnboardingCollectionOptions

Defined in: sdk/src/types/account-onboarding.ts:17

Options to control which onboarding steps are presented.

  • include scopes collection to only the listed steps.
  • exclude hides the listed steps.
  • When both are set, include is applied first, then exclude removes from that result.
  • The final_complete step is always shown regardless of these options.

Properties​

steps?​

optional steps?: object;

Defined in: sdk/src/types/account-onboarding.ts:18

exclude?​

optional exclude?: AccountOnboardingStep[];

Hide these steps, preventing the user from seeing them.

include?​

optional include?: AccountOnboardingStep[];

Show only these steps (the final_complete step is always included).