Interface JourneyClient

The journey client instance returned by the journey() function.

interface JourneyClient {
    next: (
        step: JourneyStep,
        options?: NextOptions,
    ) => Promise<JourneyResult>;
    redirect: (step: JourneyStep) => Promise<void>;
    resume: (url: string, options?: ResumeOptions) => Promise<JourneyResult>;
    start: (options?: StartParam) => Promise<JourneyResult>;
    terminate: (
        options?: { query?: Record<string, string> },
    ) => Promise<unknown>;
}

Properties

next redirect resume start terminate

Properties

next

next: (step: JourneyStep, options?: NextOptions) => Promise<JourneyResult>

redirect

redirect: (step: JourneyStep) => Promise<void>

resume

resume: (url: string, options?: ResumeOptions) => Promise<JourneyResult>

start

start: (options?: StartParam) => Promise<JourneyResult>

terminate

terminate: (options?: { query?: Record<string, string> }) => Promise<unknown>

Settings

Member Visibility

On This Page

Properties