v1.0.0-beta.4

Updating from v0.8.0 (Updated, please read again)

Added

• Added ability to stop the instance from awaiting emoji reacts with function emojis:

  <PaginationEmbed>.addFunctionEmoji('🛑', () => {
      // Either
      throw 'stopped';
  
      // or
      return Promise.reject('stopped');
  
      // will stop the instance from awaiting reacts.
      // Passing an error object will emit the `error` event.
  });

• Added PaginationEmbed#setEmojisFunctionAfterNavigation method. This allows function emojis to either be the first/last set to be deployed before/after navigation emojis.
  • Default: false.

Changed

• PaginationEmbed no longer emits an event when there is no listener (invoking .on/.once)

Removed

• Option prepare for clientAssets has been removed. This affects:
  • Setting the channel property is a must now. (Used to be either clientAssets.message or channel must be set)

Fixed

• Fixed possibly unnecessary API call on awaiting emoji reacts timeout.
  • clientMessage#delete now precedes clientMessage.reactions#removeAll

v1.0.0-beta.3

Added

• More TypeScript notices
• Master branch (unreleased) installation

Changed

• Beautify bin output

Fixed

• Unnecessary recasting of MessageEmbed on FieldsEmbed#_loadList
• Error handling
• Unnecessary re-setting clientAssets on _verify()

v1.0.0-beta.2

Updating from v0.8.0 (Updated, please read again)

Added

• Examples for README

Changed

• Updated UPDATING_V1.md

• File structure: typings imports for TypeScript projects has been changed:

  Old way

  import Embeds from 'discord-paginationembed/typings/Embeds';
  import FieldsEmbed from 'discord-paginationembed/typings/FieldsEmbed';
  
  // Unlikely
  import { IClientAssets } from 'discord-paginationembed/typings/base';

  New way

  import { Embeds, FieldsEmbed, IClientAssets } from 'discord-paginationembed';

• showPageIndicator ➡ setPageIndicator

Fixed

• Non-working examples
• Page number that is out of bounds being ignored on build()
• Missing message and channel objects being ignored
• Undefined array being ignored on Embeds mode methods

v1.0.0-beta.1

Updating from v0.8.0

Added

• New features testing for the test unit
• Updating to v1 readme
• Badges for README
• Gulp tasks

Changed

• Files structure

Removed

• Unnecessary NPM package assets being included on publish
• NPM tasks related to package building in favour of Gulp tasks

Fixed

• Typings for events and superclass
• Superclass EventEmitter's methods/properties from docs (docs noises)
• start event not being fired at all

v1.0.0-beta.0

Updating from v0.8.0

If the link above is unavailable, you may proceed to the documentation site instead.

Added

• NPM publish
• Package scripts and configs
• Changelog added
• PaginationEmbed events (from superclass EventEmitter)
• Customisable prompt message (under clientAssets.prompt)

Changed

• MessageEmbed superclass changed to EventEmitter
• MessageEmbed customisations for FieldsEmbed mode can only be access via embed property. e.g:

<FieldsEmbed>.embed
  .setColor('red')
  .setTitle('A customised embed')

• clientMessage ➡ clientAssets; including its method
• Source code: from JavaScript to TypeScript
• Tweaked typings and documentation
• README revamped (please read)

Removed

• Dependencies-relevant: yarn.lock and eslint-relevant
• Object parameter to construct an instance. Please use the methods instead

Fixed

• Current instance not being awaited properly on asynchronous functions. As example, your code that looks like this will work as expected now:

// e.g: A command has a cooldown/ratelimit for using this instance, we should wait for the instance to finish everything (either user deletes or expires the session) before we can let the user use this command again.
await <Embeds>.build();

return 'done!';

• Better typings and docs references

v0.8.0 (v12)

Added

• Added .catch() for clientMessage deletion (#23)
• Reflected MessageEmbed API (added SpliceFields, and setTimestamp now accepts a specified timestamp/date)
• Added declaration file for TypeScript users

Changed

• README has been cleaned up (removed v11 branch deprecation notice too)
• Documentation site changed from JSDoc to TypeDoc
• Use yarn command on package scripts (due to yarn.lock)

Removed

• Discord.JS stable compatibility (*-v11)

Fixed

• Better array checking
• FieldsEmbed Mode no longer puts its pageIndicator on embed description, puts at the message content instead.

v0.7.7 (D.JS v11)

Added

• functionEmoji - customised emojis with specific function (#8)
• deleteOnTimeout - option to delete the message upon awaiting response timeout (#11)
• test folder for FieldsEmbed and Embeds test bot

Changed

• Major documentation changes
• authorizedUsers is now an Array<User.id> type (#9)
• Embeds will now show clientMessage.content after pageIndicator
• emojis to navigationEmojis
• NavigationButtons to NavigationEmojis
• setEmojis to setNavigationEmojis

Removed

• docs folder; transferred to gh-pages branch

Fixed

• Support for DMs (except for message/reaction deletes).

v0.7.7 (D.JS v12)

Added

• functionEmoji - customised emojis with specific function (#8)
• deleteOnTimeout - option to delete the message upon awaiting response timeout (#11)
• test folder for FieldsEmbed and Embeds test bot

Changed

• Major documentation changes
• authorizedUsers is now an Array<User.id> type (#9)
• Embeds will now show clientMessage.content after pageIndicator
• emojis to navigationEmojis
• NavigationButtons to NavigationEmojis
• setEmojis to setNavigationEmojis

Removed

• docs folder; transferred to gh-pages branch

Fixed

• Support for DMs (except for message/reaction deletes).

0.2.3-v11

Added

• Mention user on jump page prompt

Fixed

• Original content not being kept when page indicator was not set to true
• JSDoc Typos

0.2.3

Added

• Mention user on jump page prompt

Fixed

• Original content not being kept when page indicator was not set to true
• JSDoc Typos