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

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

Properties

getState: () => unknown
next: (step: JourneyStep, options?: NextOptions) => Promise<JourneyResult>
redirect: (step: JourneyStep) => Promise<void>
resume: (url: string, options?: ResumeOptions) => Promise<JourneyResult>
start: (options?: StartParam) => Promise<JourneyResult>
subscribe: (listener: () => void) => () => void
terminate: (
    options?: { query?: Record<string, string> },
) => Promise<void | GenericError>