API.md

MWBot

MWBot library

Meta

• author: Simon Heimler

constructor

Constructs a new MWBot instance It is advised to create one bot instance for every API to use A bot instance has its own state (e.g. tokens) that is necessary for some operations

Parameters

• customOptions [{}] Custom options
• customRequestOptions [{}] Custom request options

version

Get mwbot ersion number

setOptions

Set and overwrite msbot options

Parameters

• customOptions {}

setGlobalRequestOptions

Sets and overwrites the raw request options, used by the "request" library See https://www.npmjs.com/package/request

Parameters

• customRequestOptions {}

setApiUrl

Sets the API URL for MediaWiki requests This can be uses instead of a login, if no actions are used that require one.

Parameters

• apiUrl String API Url to MediaWiki, e.g. 'https://www.semantic-mediawiki.org/w/api.php'

rawRequest

Executes a promisified raw request Uses the npm request library

Parameters

• requestOptions object

Returns bluebird

request

Executes a request with the ability to use custom parameters and custom request options

Parameters

• params object Request Parameters
• customRequestOptions object Custom request options

Returns bluebird

login

Executes a Login

Parameters

• loginOptions [object]

Returns bluebird

getEditToken

Gets an edit token This is currently only compatible with MW >= 1.24

Returns bluebird

loginGetEditToken

Combines Login with GetEditToken

Parameters

• loginOptions

Returns bluebird

create

Creates a new wiki pages. Does not edit existing ones

Parameters

• title string
• content string
• summary [string]
• customRequestOptions [object]

Returns bluebird

read

Reads the content / and meta-data of one (or many) wikipages

Parameters

• title string For multiple Pages use: PageA|PageB|PageC
• customRequestOptions [object]

Returns bluebird

update

Updates existing new wiki pages. Does not create new ones

Parameters

• title string
• content string
• summary [string]
• customRequestOptions [object]

Returns bluebird

delete

Deletes a new wiki page

Parameters

• title string
• reason [string]
• customRequestOptions [object]

Returns bluebird

edit

Edits a new wiki pages. Creates a new page if it does not exist yet

Parameters

• title string
• content string
• summary [string]
• customRequestOptions [object]

Returns bluebird

upload

Uploads a file

Parameters

• title [string]
• pathToFile string
• comment [string]
• customParams [object]
• customRequestOptions [object]

Returns bluebird

uploadOverwrite

Uploads a file and overwrites existing ones

Parameters

• title [string]
• pathToFile string
• comment [string]
• customParams [object]
• customRequestOptions [object]

Returns bluebird

batch

Combines all standard CRUD operations into one concurrent batch operation The batch request will also print log messages about the current job status It includes some more detailed error handling

If the concurrency is set to 1, it ensures a sequential order by switching from Promise.map to Promise.mapSeries

Parameters

• jobs (object | array)
• summary [string]
• concurrency [number]
• customRequestOptions [object]

sparqlQuery

Executes a SPARQL Query Defaults to use the wikidata endpoint

Parameters

• query string
• endpointUrl [string]
• customRequestOptions [object]

Returns bluebird

askQuery

Execute an ASK Query

Parameters

• query string
• apiUrl [string]
• customRequestOptions [object]

Returns bluebird

merge

Recursively merges two objects

Parameters

• parent object Parent Object
• child object Child Object; overwrites parent properties

Returns object Merged Object

logStatus

Prints status information about a completed request

Parameters

• status
• currentCounter
• totalCounter
• operation
• pageName
• reason

Promise

Provide bluebird.js Promise

map

Provide bluebird.js Promise.map for concurrent batch requests

mapSeries

Provide bluebird.js Promise.mapSeries for sequential batch requests