Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
wiki-saikou
Advanced tools
Readme
SUPER COOL api package for MediaWiki
- 同时兼容浏览器&Node.js 环境 -
- Support both browser and Node.js environment -
本库提供了与原版 new mw.Api()
非常相似的 api 请求封装。让你在非 MediaWiki 环境中轻松实现各种 wiki 操作。使用 TypeScript 编写~
The library provides the out of box accessing to MediaWiki API in both browsers & Node.js, and the syntax is very similar to vanilla new mw.Api()
. TypeScript definition included~
new mw.Api()
{ "foo": ["bar", "baz"], watch: false }
→ { "foo": "bar|baz" }
安装 Installation
# Via pnpm:
pnpm add wiki-saikou
# Yarn? sure:
yarn add wiki-saikou
# Or just npm:
npm install wiki-saikou
Then, import it to your project:
import { MediaWikiApi } from 'wiki-saikou'
const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php')
// ...
在浏览器中直接使用 Use directly in the browser
import('https://unpkg.com/wiki-saikou?module').then(({ MediaWikiApi }) => {
const api = new MediaWikiApi('https://zh.moegirl.org.cn/api.php')
// ...
})
Then use it just like the new mw.Api()
You can find some sample code snippets here.
Below is the documentation of MediaWikiApi.
MediaWikiApi
{class MediaWikiApi}Main methods:
new MediaWikiApi(baseURL?: string, options?: Partial<FexiosConfigs>)
baseURL
: API endpoint of your target wiki site (e.g. https://mediawiki.org/w/api.php)
options
: {LylaRequestOptions}login(username: string, password: string): Promise<{ result: 'Success' | 'Failed'; lguserid: number; lgusername: string }>
Login your account.
get<T = any>(params: MwApiParams, options?: FexiosRequestOptions): Promise<FexiosFinalContext<T>>
Make GET
request
post<T = any>(body: MwApiParams, options?: LylaRequestOptions): Promise<FexiosFinalContext<T>>
Make POST
request
postWithToken<T = any>(tokenType: MwTokenName, body: MwApiParams, options?: LylaRequestOptions): Promise<FexiosFinalContext<T>>
Make POST
request with specified token.
type MwTokenName =
| 'createaccount'
| 'csrf'
| 'login'
| 'patrol'
| 'rollback'
| 'userrights'
| 'watch'
get request
{Fexios}Get Fexios
instance of current MediaWikiApi instance
MediaWikiApi.normalizeParamValue(params: MwApiParams[keyof MwApiParams]): string | File | undefined
(static)Normalize input params to standard MediaWiki request params.
string[] → string
: ['foo', 'bar', 'baz'] → 'foo|bar|baz
false → undefined
: remove false itemsMediaWikiApi.createRequestHandler(baseURL: string, options?: Partial<FexiosRequestOptions>): Fexios
(static)Create your own Fexios instance.
Warning: The instance created by this method does not include responsive getters/setters (described below) and the out of box cookie controls.
get/set defaultOptions
{AxiosRequestOptions} (responsive* getter/setter)defaults: {}
get/set defaultParams
{MwApiParams} (responsive* getter/setter)defaults:
this.defaultParams = {
action: 'query',
errorformat: 'plaintext',
format: 'json',
formatversion: 2,
}
Modifying these properties on the instance will automatically recreate the Axios instance of current MediaWikiApi instance. You can modify them directly and safely.
MIT License
Copyright (c) 2022 萌娘百科 User:机智的小鱼君 (A.K.A. Dragon-Fish)
FAQs
The library provides the out of box accessing to MediaWiki API in both browsers & Node.js, and the syntax is very similar to vanilla `new mw.Api()`. TypeScript definition included~
The npm package wiki-saikou receives a total of 36 weekly downloads. As such, wiki-saikou popularity was classified as not popular.
We found that wiki-saikou demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.