Type Alias Credentials

Credentials: XOR<
    { oAuth2AccessToken: string },
    {
        accessSecret: string;
        accessToken: string;
        consumerSecret: string;
        consumerToken: string;
    },
    { password: string; username: string },
    { anonymous: true },
>

User credentials for authentication.

When calling Mwbot.constructor, one of the following credential types must be provided under the credentials key in the MwbotInitOptions object.

OAuth 2.0 (https://www.mediawiki.org/wiki/OAuth/Owner-only_consumers#OAuth_2)

{
  oAuth2AccessToken: 'Your OAuth 2.0 access token'
}

OAuth 1.0a (https://www.mediawiki.org/wiki/OAuth/Owner-only_consumers#OAuth_1)

{
  consumerToken: 'Your OAuth 1.0a consumer token',
  consumerSecret: 'Your OAuth 1.0a consumer secret',
  accessToken: 'Your OAuth 1.0a access token',
  accessSecret: 'Your OAuth 1.0a access secret'
}

BotPassword (https://www.mediawiki.org/wiki/Manual:Bot_passwords)

{
  username: 'Your bot username',
  password: 'Your bot password'
}

Anonymous Access

{
  anonymous: true
}

NOTE: Anonymous users will be limited to non-write requests only.