Socket
Socket
Sign inDemoInstall

gotmw

Package Overview
Dependencies
61
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    gotmw

MediaWiki client using Got.js


Version published
Maintainers
1
Created

Readme

Source

gotmw.js

MediaWiki client on top of Got.js and many others.

Examples

Here are some examples to using gotmw.js.

Interactive command line interface to en.wikipedia.org

List options for the command line interface:

node sample/wikipedia/wikipedia-cli.js
categories (query prop)

Get all categories for a wiki page:

node sample/wikipdia/wikipedia-cli.js -a query -p categories --titles 'UEFA Euro 2020'
categorymembers (query list)

List all pages for a wiki category.

node sample/wikipdia/wikipedia-cli.js -a query -l categorymembers --cmtitle 'Category:UEFA Euro 2020' --cmtype page --cmlimit 20

The option --cmtype could be

  • subcat for sub categories
  • file for files
  • page for wiki pages
search (query list)

Execute a simple search.

node sample/wikipedia/wikipedia-cli.js -a query -l search --srsearch='intitle:Ava film'
node sample/wikipedia/wikipedia-cli.js -a query -l search --srsearch='benji' --srlimit=3 --srnamespace="6|14"

The details options could find on page API:Search Wikipedia is using CirrusSearch. The advanced search syntax could be found on page Help:CirrusSearch.

The option --srprop has the properties for snippets from page content, page title, section title and category:

  • snippet
  • sectiontitle
  • sectionsnippet

The option --srnamespace will set the namespaces to search in. Here are some common namespaces:

  • 0 main namespace
  • 14 category
  • 6 file

The default namespaces are list on page Help:Namespaces.

opensearch

The sample for API:Opensearch action:

node sample/wikipedia/wikipedia-cli.js -a opensearch --search="Hampi" --limit=10 --namespace="0|6"
recentchanges (query list)

List all recent changes, details on page API:RecentChanges.

node sample/wikipedia/wikipedia-cli.js -a query -l recentchanges --rclimit=3
imageinfo (query prop)

The action API:Imageinfo could be used to get the thumbnail url. It also could get the thumbnail image for a pdf file. Here is a sample:

node sample/wikipedia/wikipedia-cli.js -a query -p imageinfo --titles='File:JUA0680291.pdf' --iiprop="url|size" --iiurlwidth=120
extracts (query prop)

The help page Get the contents of a page has a full list of methods for tetrieving page content by the API. This is the only way to get excerpt from a wiki page.

The extracts action depends on the Extension:TextExtracts.

node sample/wikipedia/wikipedia-cli.js -a query -p extracts --titles='Benji' --exchars=175 --explaintext=true
parse

The API:Parse action has the option to only parse one of the section. The section 0 is the paragraphs before the first section.

node sample/wikipedia/wikipedia-cli.js -a parse --page="Benji" -p text --section=0 --preview=true

Keywords

FAQs

Last updated on 03 Sep 2021

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc