mwbot-ts - v1.2.7
    Preparing search index...

    Interface MwbotErrorCodes

    This interface defines error types and error codes generated by mwbot-ts.

    The string values are descriptions of the error codes and not referenced or used in the source code.

    interface MwbotErrorCodes {
        api: {};
        api_mwbot: {
            aborted: "Request aborted by the user.";
            anonymous: "Anonymous users are limited to non-write requests.";
            badauth: "Failed to authenticate the client as a registered user in Mwbot.init.";
            badgateway: "Bad gateway (502)";
            badnamedtoken: "An unknown token name was specified for Mwbot.getToken.";
            baduri: "URI too long (414).";
            badvars: "Failed to initialize wg-variables in Mwbot.init.";
            botdenied: "The target page has opted out of edits by this bot or the message types it delivers.";
            editfailed: "The edit attempt failed with a `result: \"Failure\"` code.";
            empty: "OK response but empty result.";
            emptytitle: "The given title cannot be processed because it is empty.";
            http: "Encountered an HTTP request error that is not mapped to a specific error code.";
            interwikititle: "The given title cannot be processed because it is interwiki.";
            invalidformat: "Not using \"format=json\" in request parameters.";
            invalidjson: "No valid JSON response.";
            invalidtitle: "The given title cannot be processed because it is invalid.";
            loginfailed: "Failed to log in.";
            nopermission: "You do not have permission to perform this action.";
            notfound: "Page not found (404).";
            pagemissing: "The requested page does not exist.";
            ratelimited: "Too many requests (429).";
            servererror: "Internal server error (500).";
            serviceunavailable: "Service Unavailable (503)";
            specialtitle: "The given title cannot be processed because it is in the Special or Media namespace.";
            timeout: "Request timeout (408) or Gateway timeout (504).";
        };
        fatal: {
            emptyinput: "A required input value is empty.";
            fieldmismatch: "API parameters passed to massRequest() or continuedRequest() involve unmatching multi-value fields.";
            internal: "An unexpected internal error occurred.";
            invalidcreds: "There is an issue with the credential information passed to Mwbot.";
            invalidlimit: "The \"limit\" argument for continuedRequest() is invalid.";
            invalidsize: "The \"batchSize\" argument for massRequest() or continuedRequest() is invalid.";
            invalidtype: "Wikitext.modify does not support this expression type.";
            nofields: "No multi-value fields are provided for massRequest() or continuedRequest().";
            nourl: "No valid API endpoint is provided.";
            typemismatch: "There is an issue with the type of a variable.";
            unparsabletitle: "The title string passed to Title.constructor cannot be parsed.";
        };
    }
    Index

    Properties

    api api_mwbot fatal

    Properties

    api: {}

    Marks errors from HTTP requests returned by the MediaWiki API.

    This property is always an empty object because the API itself defines the error codes.

    api_mwbot: {
        aborted: "Request aborted by the user.";
        anonymous: "Anonymous users are limited to non-write requests.";
        badauth: "Failed to authenticate the client as a registered user in Mwbot.init.";
        badgateway: "Bad gateway (502)";
        badnamedtoken: "An unknown token name was specified for Mwbot.getToken.";
        baduri: "URI too long (414).";
        badvars: "Failed to initialize wg-variables in Mwbot.init.";
        botdenied: "The target page has opted out of edits by this bot or the message types it delivers.";
        editfailed: "The edit attempt failed with a `result: \"Failure\"` code.";
        empty: "OK response but empty result.";
        emptytitle: "The given title cannot be processed because it is empty.";
        http: "Encountered an HTTP request error that is not mapped to a specific error code.";
        interwikititle: "The given title cannot be processed because it is interwiki.";
        invalidformat: "Not using \"format=json\" in request parameters.";
        invalidjson: "No valid JSON response.";
        invalidtitle: "The given title cannot be processed because it is invalid.";
        loginfailed: "Failed to log in.";
        nopermission: "You do not have permission to perform this action.";
        notfound: "Page not found (404).";
        pagemissing: "The requested page does not exist.";
        ratelimited: "Too many requests (429).";
        servererror: "Internal server error (500).";
        serviceunavailable: "Service Unavailable (503)";
        specialtitle: "The given title cannot be processed because it is in the Special or Media namespace.";
        timeout: "Request timeout (408) or Gateway timeout (504).";
    }

    Marks errors of HTTP requests, generated by mwbot-ts.

    fatal: {
        emptyinput: "A required input value is empty.";
        fieldmismatch: "API parameters passed to massRequest() or continuedRequest() involve unmatching multi-value fields.";
        internal: "An unexpected internal error occurred.";
        invalidcreds: "There is an issue with the credential information passed to Mwbot.";
        invalidlimit: "The \"limit\" argument for continuedRequest() is invalid.";
        invalidsize: "The \"batchSize\" argument for massRequest() or continuedRequest() is invalid.";
        invalidtype: "Wikitext.modify does not support this expression type.";
        nofields: "No multi-value fields are provided for massRequest() or continuedRequest().";
        nourl: "No valid API endpoint is provided.";
        typemismatch: "There is an issue with the type of a variable.";
        unparsabletitle: "The title string passed to Title.constructor cannot be parsed.";
    }

    Marks fatal exceptions attributed to the user's source code.

    Settings

    Member Visibility

    On This Page

    Properties