@quority/core

---

Typed MediaWiki API wrapper for node.js, focused on supporting MediaWiki's Action API.

• Features
• Installation
• Usage
  • Wiki instance
  • Custom strategy
  • Log in

Features

• Written in TypeScript.
• Extendable API.
• Full TypeScript and JavaScript support.
• Can be used with CJS (require) or ESM (import).

Installation

# npm
npm install @quority/core

# yarn
yarn add @quority/core

Usage

For most uses, you will want to import the Wiki constructor. Code snippets will use ESM syntax, but you can use require instead:

// ESM
import { Wiki } from '@quority/core'

// CJS
const { Wiki } = require( '@quority/core' )

Wiki instance

import { Wiki } from '@quority/core'

const wiki = new Wiki( {
	api: 'https://www.mediawiki.org/w/api.php'
} )

By default, you'll need to use the API url for the wiki. This behavior can be changed using a strategy.

Custom strategy

Strategies allow you to add support to custom features for a MediaWiki installation, or to change how is the api interpreted in the wiki's constructor.

The following example will allow you to create Wiki instances for a Wikipedia by just defining its language in the api property of the constructor.

import { BaseStrategy } from '@quority/core'

class WikipediaStrategy extends BaseStrategy {
	public static override getApi( api: string ): URL {
		return new URL( `https://${ api }.wikipedia.org/w/api.php` )
	}
}

⚠️ You might want to throw an error if the parameter isn't a language code.

The strategy can be manually set in the constructor of an instance:

const wiki = new Wiki( {
	api: 'es',
	platform: WikipediaStrategy
} )

Or you can extend a class that will use your custom strategy by default:

class Wikipedia extends Wiki {
	public static override readonly defaultStrategy = WikipediaStrategy
}

const wiki = new Wikipedia( {
	api: 'es'
} )

Strategies can also be used to add support to different API endpoints that aren't included in default MediaWiki installations. This is pending to be documented.

Log in

You can login to get a Bot instance by using the #login method in Wiki.

import { Wiki } from '@quority/core'

const wiki = new Wiki( {
	api: 'https://www.mediawiki.org/w/api.php'
} )
const bot = await wiki.login( 'BotPasswords user', 'BotPasswords password' )

💾 If you aren't familiar with BotPasswords, you may find useful to read Bot passwords & you (& your bot (& you))

The bot instance supports most actions that can be performed through the API as individual methods:

await bot.edit( {
	text: 'This is a test',
	title: 'Test'
} )

All actions will be made on the wiki that created the instance.