Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 2.7 KB

CHANGELOG.md

File metadata and controls

47 lines (33 loc) · 2.7 KB
Raw

Only breaking changes, deprecations and the like are documented in this change log.

2.0.1

  • oresQueryRevisions() has been deprecated, since the ORES service is being deprecated in favour of Lift Wing.

2.0.0

  • Class names now follow the standard PascalCase convention. The older names are deprecated.
    • mwn -> Mwn
      • The library should now be imported as import {Mwn} from 'mwn' instead of import {mwn} from 'mwn'
    • bot.title -> bot.Title (where bot is an instance of Mwn)
    • bot.page -> bot.Page
    • bot.category -> bot.Category
    • bot.file -> bot.File
    • bot.user -> bot.User
    • bot.wikitext -> bot.Wikitext
    • bot.date -> bot.Date
    • mwn.table -> Mwn.Table
  • Class for querying Wikimedia EventStreams have been removed. Consider using the dedicated library wikimedia-streams instead.
  • set* methods on MwnDate objects (eg. setUTCDate) used to be chainable as they returned this. Because MwnDate extends the native Date, the change in return values was not possible to represent in TypeScript types (Liskov substitution principle). This undocumented feature has now been removed for the sake of accurate types.
  • printYaml logging config option is no longer supported in Mwn.setLoggingConfig() method.
  • mwn#queryAuthors() which had been deprecated has now been removed. Instead, please use queryAuthors() method on page objects.

0.11.0

  • mwn#queryAuthors() now requires getSiteInfo() to have run first. Also, it is deprecated in favour of using the queryAuthors() method on a page object.

0.10.0

  • loginGetToken() is now deprecated in favour of login() which will now fetch tokens as well.
  • TypeScript source files are dropped from the npm package, per the standard practice followed in TypeScript libraries. This should not actually break anything.

0.9.0

BREAKING CHANGES:

  • mwn#rawRequest now returns the AxiosResponse object directly, rather than the data part of AxiosResponse.
  • In cases of error, the shape of the error thrown by mwn#request is different.
    • Earlier: error.response was the API response data along with response and request objects, the former making it a cyclic object.
    • Now: error.response is an object with fields {data, headers, status, statusText}

0.8.0

BREAKING CHANGES:

  • For imports in JavaScript, use const {mwn} = require('mwn'); instead of const mwn = require('mwn');