W-CF Documentation - v11.0.0
    Preparing search index...

    Interface WcfConfig

    interface WcfConfig {
        ajaxDefaultOptions: Required<AjaxOptions>;
        ajaxErrorHandler?: (pError: AjaxErrorInfo) => void;
        ajaxGetRetryDelay: (pRetryCount: number) => number;
        ajaxRejectedEvent?: (
            pRequestInfo: AjaxRequestInfo,
            pXhr: XMLHttpRequest,
            pError: Error,
        ) => void;
        ajaxResolvedEvent?: (
            pRequestInfo: AjaxRequestInfo,
            pXhr: XMLHttpRequest,
        ) => void;
        articleConfigurationOptions: ArticleConfigurationOptions;
        dataPath?: string;
        fetchDefaultOptions: FetchOptions;
        fetchErrorHandler?: (pError: FetchErrorInfo) => void;
        fetchRejectedEvent?: (
            pUrl: string,
            pOptions: FetchOptions,
            pResponse: Response | undefined,
            pError: unknown,
        ) => void;
        fetchResolvedEvent?: (
            pUrl: string,
            pOptions: FetchOptions,
            pResponse: Response,
        ) => void;
        loadContentErrorHandler?: (pError: LoadContentErrorInfo) => void;
    }
    Index
    ajaxDefaultOptions: Required<AjaxOptions>

    Default options used for ajax requests.

    ajaxErrorHandler?: (pError: AjaxErrorInfo) => void

    Global ajax error handler which can be used to capture and handle all ajax errors.

    ajaxGetRetryDelay: (pRetryCount: number) => number

    Function which returns a delay (in ms) for the next ajax retry attempt based on the retry counter. Can be overridden for custom delays. (default: 200ms * pRetryCount)

    ajaxRejectedEvent?: (
        pRequestInfo: AjaxRequestInfo,
        pXhr: XMLHttpRequest,
        pError: Error,
    ) => void

    Global event which will be triggered for every failed ajax request.

    ajaxResolvedEvent?: (
        pRequestInfo: AjaxRequestInfo,
        pXhr: XMLHttpRequest,
    ) => void

    Global event which will be triggered for every successful ajax request.

    articleConfigurationOptions: ArticleConfigurationOptions

    Options for article configuration.

    dataPath?: string

    Path of the W-CF data folder. e.g. /wcf/data/

    fetchDefaultOptions: FetchOptions

    Default options used for fetch requests.

    fetchErrorHandler?: (pError: FetchErrorInfo) => void

    Global fetch error handler which can be used to capture and handle all fetch errors.

    fetchRejectedEvent?: (
        pUrl: string,
        pOptions: FetchOptions,
        pResponse: Response | undefined,
        pError: unknown,
    ) => void

    Global event which will be triggered for every failed fetch request.

    fetchResolvedEvent?: (
        pUrl: string,
        pOptions: FetchOptions,
        pResponse: Response,
    ) => void

    Global event which will be triggered for every successful fetch request.

    loadContentErrorHandler?: (pError: LoadContentErrorInfo) => void

    Global error handler which can be used to capture and handle all content loading errors (DomUtils).