npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

types-mediawiki

v1.6.0

Published

TypeScript definitions for MediaWiki JS interface

Downloads

726

Readme

NPM version Linter PRs Welcome

types-mediawiki

TypeScript definitions for MediaWiki JS interface.

This package covers the functions and classes in the mw global object, as well some jQuery plugins used in MediaWiki core. All commonly used parts of the interface are covered.

@types/jquery and @types/oojs-ui from DefinitelyTyped are included as dependencies, so you don't need to install them separately.

Download stats

Usage

To use types from this package, run

npm i types-mediawiki

Edit your project's tsconfig.json file so that it includes

"include": [
  "./node_modules/types-mediawiki"
]

You should be all set! mw will be available in the global scope. There is no need to put any import statements in the TypeScript source files.

If you find any errors or have suggestions for more specific typings, please open a PR or file an issue.

mw.config

Types for mw.config are included:

let NS = mw.config.get("wgNamespaceNumber"); // NS gets type number
let pageName = mw.config.get("wgPageName"); // pageName gets type string

mw.config entries added by MediaWiki extensions can also be used but their type is not known, so they need to be explicitly cast:

let namespaces = mw.config.get("pageTriageNamespaces") as number[];

(mw.config.get('pageTriageNamespaces') gets the type unknown without a cast.)

MediaWiki API parameters

This package also provides typings for API request parameters for the MediaWiki Action API. API endpoints defined in MediaWiki core and by a number of common extensions (the ones enabled on English Wikipedia) are covered. These aren't exported to the global scope, however. For usage, you need to import them. For example:

import type { ApiEditPageParams, ApiParseParams } from "types-mediawiki/api_params";

Since it is just a type import, it doesn't generate any JavaScript. Hence, such imports can also be used in non-modular applications.