Registry / devops / types-mediawiki-api

types-mediawiki-api

library2.0.0jsnpmunverified

TypeScript type definitions for MediaWiki Action API request parameters. Covers MediaWiki core and common extensions (e.g., enabled on English Wikipedia). Current stable version is 2.0.0. Split from types-mediawiki in v2. Published on npm; no runtime dependencies.

devops

npm install types-mediawiki-api

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TYPES-MEDIAWIKI-AP

types-mediawiki-api

devopsjavascriptv2.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ApiEditPageParams

✓ import type { ApiEditPageParams } from 'types-mediawiki-api'

✗ import { ApiEditPageParams } from 'types-mediawiki-api'

Use 'import type' since this package only provides types; no JavaScript runtime code.

ApiParseParams

✓ import type { ApiParseParams } from 'types-mediawiki-api'

✗ const { ApiParseParams } = require('types-mediawiki-api')

CommonJS require() will not work because the package exports only types, not values.

ApiQueryParams

✓ import type { ApiQueryParams } from 'types-mediawiki-api'

Available as part of the type exports. Check the package for full list of exported types.

Demonstrates importing and using MediaWiki API parameter types for common actions: edit, parse, query.

// Install: npm i types-mediawiki-api import type { ApiEditPageParams, ApiParseParams, ApiQueryParams } from 'types-mediawiki-api'; // Example usage: type-check API call parameters const editParams: ApiEditPageParams = { action: 'edit', title: 'Test', text: 'Hello world', token: 'abc123' }; const parseParams: ApiParseParams = { action: 'parse', page: 'Test', prop: 'text' }; const queryParams: ApiQueryParams = { action: 'query', list: 'allpages', aplimit: 'max' };

Debug

Known issues

breakingPackage v2 split from types-mediawiki; imports have changed

fix

Migrate from 'types-mediawiki' to 'types-mediawiki-api'. Update import paths accordingly.

affects: <2.0.0

gotchaPackage only contains TypeScript types; it cannot be used at runtime or with require() in CommonJS

fix

Use import type { ... } from 'types-mediawiki-api' or configure TypeScript to skip module resolution for types-only packages.

affects: >=1.0.0

deprecatedSome parameter types may become outdated as MediaWiki API evolves

fix

Check the package version against the MediaWiki version you use. Submit issues/pull requests to update types.

affects: >=1.0.0

Errors

Common errors & fixes

Cannot find module 'types-mediawiki-api'

Package not installed or not in node_modules

fix

Run 'npm install types-mediawiki-api' (dev dependency) and ensure tsconfig.json includes node_modules in module resolution.

Module 'types-mediawiki-api' has no exported member 'ApiEditPageParams'.

Typo in export name or import path; or using an outdated version

fix

Verify the correct export name (e.g., ApiEditPageParams). Update to latest version: npm update types-mediawiki-api

Upgrade

Version history

2.0.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

5 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/wikimedia-gadgets/types-mediawiki-api ↗

packagetypes-mediawiki-api ↗

homepagehttps://github.com/wikimedia-gadgets/types-mediawiki-api#readme ↗