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

    Interface MwbotInitOptions

    Options to be passed as the first argument of Mwbot.init.

    interface MwbotInitOptions {
        apiUrl: string;
        credentials: Credentials;
        interval?: number;
        intervalActions?: ApiParamsAction[];
        suppressWarnings?: boolean;
        userAgent?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    apiUrl credentials interval? intervalActions? suppressWarnings? userAgent?

    Properties

    apiUrl: string

    The API endpoint to initialize the Mwbot instance with.

    credentials: Credentials
    interval?: number

    Minimum interval (in milliseconds) between consecutive API requests. See intervalActions for the relevant API actions.

    Default: 5000 (5 seconds)

    To disable intervals, set intervalActions to an empty array.

    intervalActions?: ApiParamsAction[]

    API actions that require an enforced interval.

    Default: ['edit', 'move', 'upload']

    Set an empty array to disable intervals.

    suppressWarnings?: boolean

    Whether to suppress warnings returned by the API.

    userAgent?: string

    Custom User-Agent string for requests.

    Format: clientname/version (contact information e.g., username, email) framework/version...

    https://www.mediawiki.org/wiki/API:Etiquette#The_User-Agent_header

    Settings

    Member Visibility

    On This Page

    Properties