Skip to content

v0.1.3

Choose a tag to compare

@kaimoe kaimoe released this 26 Mar 19:50

Important Change:

Changes have been made with how XIVAPI handles its API keys from now on. As a result, the way keys are provided during initialization of the module has also changed:

  • Since the API keys are no longer mandatory, you can simply init without providing one:
const xiv = new XIVAPI()
  • If you want to use a key, you can do so by adding it to the optional global params object.
const xiv = new XIVAPI( { private_key: 'myKey' } )

The old way of providing an API key separately from the global parameters will no longer work, and show a warning instead. If you want to change your existing code, you should get your new API key (only from the staging version right now) and make the following change:

Old:

const xiv = new XIVAPI('myOldKey', { [other params] })

New:

const xiv = new XIVAPI({ private_key: 'myNewKey', [other params] })

Other changes: