@sheerid/jslib-nightly
Version:
SheerID JavaScript Library
34 lines (32 loc) • 1.63 kB
TypeScript
import { VerificationStep, VerificationResponse, MockStep } from '../types/types';
/**
* Get a string value either from the query string (first priority) or from the options object (second priority)
*
* NOTICE: often the query param's property name differs from the options object's property name so be aware.
* Going forward it's easier if they are the same. See QUERY_STRING_DOC_SELECTED for an example.
*/
export declare const getQueryOrOption: (propertyName: string) => string | undefined;
export declare const isMockedStep: () => boolean;
export declare const getRouteOverride: (response?: VerificationResponse) => MockStep | undefined;
/**
* @deprecated Use getQueryOrOption directly, instead
* When loading the error step, specify an errorId
*/
export declare const getPreviousStepOverride: () => VerificationStep | undefined;
/**
* @deprecated Use getQueryOrOption directly, instead
* Special case. The loading screen is not a step, so mocking it is a little different.
*/
export declare const isMockingLoading: () => boolean;
/**
* @deprecated Use getQueryOrOption directly, instead
* Special case when mocking loading. To get text to show up, specify a previous step
*/
export declare const getMockedLoadingStep: () => VerificationStep;
/**
* Based on page request query params, return a fake response to allow direct access to any step.
*
* @param overriddenStep
* @param serverResponse The actual serverResponse to acquire certain pieces of info from.
*/
export declare const getOverriddenMock: (overriddenStep: MockStep, serverResponse?: VerificationResponse) => Promise<VerificationResponse>;