mhdscraper - v1.0.3

Index

Interfaces

Variables

WIKI_URL

Functions

Variables

Const WIKI_URL

WIKI_URL: "https://dumps.wikimedia.org/other/mediawiki_history" = 'https://dumps.wikimedia.org/other/mediawiki_history'

The wiki url of the "Mediawiki history dumps - tsv"

Functions

fetchDumps

fetchDumps(version: string, wiki: string, options?: DumpOptions): Promise<Dump[]>

Fetches the dumps of a wiki of the mediawiki history dumps

Parameters
- version: string
  
  The version of the wiki (yyyy-mm or 'latest')
- wiki: string
  
  The wiki whose dumps will be returned (e.g. 'itwiki')
- options: DumpOptions = {}
  
  The options of the function
Returns Promise<Dump[]>

The fetched dumps

fetchLatestVersion

fetchLatestVersion(options?: VersionOptions): Promise<Version | null>

Fetches the latest version the mediawiki history dumps

Parameters
- options: VersionOptions = {}
  
  The options of the function
Returns Promise<Version | null>

The latest version

fetchVersions

fetchVersions(options?: VersionOptions): Promise<Version[]>

Fetches the versions of the mediawiki history dumps

Parameters
- options: VersionOptions = {}
  
  The options of the function
Returns Promise<Version[]>

The fetched versions

fetchWikies

fetchWikies(version: string, options?: WikiOptions): Promise<Wiki[]>

Fetches the wikies of a version of the mediawiki history dumps

Parameters
- version: string
  
  The version of the wiki (yyyy-mm or 'latest')
- options: WikiOptions = {}
  
  The options of the function
Returns Promise<Wiki[]>

The fetched wikies

Generated using TypeDoc