Requirements

Installation

Using npm

npm install nodemw

Development version

git clone https://github.com/macbre/nodemw.git

Features

Where it's used

First script

cd examplesnode pagesInCategory.js

DEBUG=1 node examples/pagesInCategory.js

DRY_RUN=1 node examples/pagesInCategory.js

Running unit tests

npmtest

How to use it?

Creating a bot instance

varbot=require("nodemw");// pass configuration objectvarclient=newbot({protocol:"https",// Wikipedia now enforces HTTPSserver:"en.wikipedia.org",// host name of MediaWiki-powered sitepath:"/w",// path to api.php scriptdebug:false,// is more verbose when set to true});client.getArticle("foo",function(err,data){// error handlingif(err){console.error(err);return;}// ...});

Config file

// read config from external filevarclient=newbot("config.js");

{"protocol":"https",// default to 'http'"server":"en.wikipedia.org",// host name of MediaWiki-powered site"path":"/w",// path to api.php script"debug":false,// is more verbose when set to true"username":"foo",// account to be used when logIn is called (optional)"password":"bar",// password to be used when logIn is called (optional)"domain" :"auth.bar.net",// domain to be used when logIn is called (optional)"userAgent":"Custom UA",// define custom bot's user agent"concurrency":5// how many API requests can be run in parallel (defaults to 3)}

Making direct API calls

varbot=require("nodemw"),client=newbot({server:"semantic-mediawiki.org",path:"/w",}),params={action:"ask",query:"[[Modification date::+]]|?Modification date|sort=Modification date|order=desc",};client.api.call(params/* api.php parameters */,function(err/* Error instance or null */,info/* processed query result */,next/* more results? */,data/* raw data */){console.log(data&&data.query&&data.query.results);});

Bot methods

bot.logIn(username, password, callback)

bot.getCategories(prefix, callback)

bot.getAllPages(callback)

bot.getPagesInCategory(category, callback)

bot.getPagesInNamespace(namespace, callback)

bot.getPagesByPrefix(prefix, callback)

bot.getPagesTranscluding(page, callback)

bot.getArticle(title, [redirect,] callback)

bot.getArticleRevisions(title, callback)

bot.getArticleCategories(title, callback)

bot.getArticleInfo(title, callback)

bot.edit(title, content, summary, minor, callback)

bot.append(title, content, summary, callback)

bot.prepend(title, content, summary, callback)

bot.addFlowTopic(title, topic, content, callback)

bot.delete(title, reason, callback)

bot.purge(titles, callback)

bot.protect(title, protections, options, callback)

{    action: string,    level?: string = 'all',    expiry?: string | number = 'never'}

bot.sendEmail(username, subject, text, callback)

bot.getToken(title, action, callback)

bot.whoami(callback)

bot.whois(username, callback)

bot.whoare(usernames, callback)

bot.createAccount(username, password, callback)

bot.move(from, to, summary, callback)

bot.getImages(callback)

bot.getImageUsage(filename, callback)

bot.getImagesFromArticle(title, callback)

bot.getImageInfo(filename, callback)

bot.getLog(type, start, callback)

bot.expandTemplates(content, title, callback)

bot.parse(content, title, callback)

bot.fetchUrl(url, callback)

bot.getRecentChanges(start, callback)

bot.getSiteInfo(props, callback)

bot.getSiteStats(props, callback)

bot.getMediaWikiVersion(callback)

client.getQueryPage(queryPage, callback)

bot.upload(filename, content, summary/* or extraParams */, callback)

bot.uploadByUrl(filename, url, summary/* or extraParams */, callback)

bot.uploadVideo(fileName, url, callback)

bot.getTemplateParamFromXml(tmplXml, paramName)

bot.getExternalLinks(title, callback)

bot.getBacklinks(title, callback)

bot.search(query, callback)

Helpers

bot.getConfig(key, def)

bot.setConfig(key, val)

bot.diff(old, current)

Wikia-specific bot methods

bot.wikia.getWikiVariables(callback)

bot.wikia.getUser(userId, callback)

bot.wikia.getUsers(userIds, callback)

WikiData

constwikidata=require("nodemw/lib/wikidata");constclient=newwikidata();// Where is Saksun, Faroe Islands located?constgeo=awaitclient.getEntityClaim("Q928875"/* Saksun */,"P625"/* place location */);// will give you the geolocation of the placeexpect(geo[0].mainsnak.datavalue.value).toMatchObject({latitude:62.248888888889,longitude:-7.1758333333333,});// When was Albert Einstein born?constres=awaitclient.getArticleClaims("Albert Einstein");constdateOfBirth=res.P569[0].mainsnak.datavalue.value;expect(dateOfBirth.time).toMatch(/1879-03-14/);constdateOfDeath=res.P570[0].mainsnak.datavalue.value;expect(dateOfDeath.time).toMatch(/1955-04-18/);// interwiki links for a given artliceconstlinks=awaitclient.getArticleSitelinks("Albert Einstein");console.log(links.enwiki);// {site: "enwiki", title: "Albert Einstein", badges: ["Q17437798"]}

Stargazers over time