Version 1.2.2 (Important Fix)

• Fixed #92 (Very important)
  This has been done by changing the behaviour of Update so that it now acts identically to updating the cache and then calling Save, rather than setting the cache to the result of the UpdateAsync. This is worth keeping in mind if you were relying on this behaviour, but this behaviour was not intentional.
• Fixed #90
• Fixed #86
• Reformatted some warnings so that they are easier to search for in Roblox's Error Analytics

Version 1.2.1

• Adds more debug information (key) when an auto-save fails

Version 1.2.0

What's Changed

This update introduces "action signals", designed to replace hooks. They provide better types, full result information, and more functionality (since signals have a :Wait method). You can retrieve these signals with the 5 new getter methods. This includes a new highly-requested cache changed signal.

This update also adds an option to disable BindToClose saves, to improve testing speeds in Studio.

Furthermore, the documentation has been updated and supplying a migrations table is now optional.

PRs (details):

• feat: add option to disable bindtoclose by @christopher-buss in #79
• Add action signals, deprecate after hooks (v1.2.0). by @anthony0br in #85

New Contributors

• @christopher-buss made their first contribution in #79

Full Changelog: v1.1.3...v1.2.0

Version 1.1.3

What's Changed

• Important Fix: Fix hooks not all being executed if the currently executing hook is cleaned up by @Great-Bird in #72
  Note that you can't cancel a future hook from a previous hook connected to the same event, but cancelling a hook after running no longer results in a hook being skipped.
• Export DocumentStoreProps & DocumentStore for easier access. by @kineticwallet in #71

New Contributors

• @Great-Bird made their first contribution in #72

Full Changelog: v1.1.2...v1.1.3

v1.1.2

What's Changed

• Add valid utf8 check to assetStorable by @checkraisefold in #69

New Contributors

• @checkraisefold made their first contribution in #69

Full Changelog: v1.1.1...v1.1.2

Version 1.1.1

• Provides more specific details on why a value could not be saved to Data Stores (#56)

Version 1.1.0

What's Changed

• Hooks now return a cleanup function, which can be used to cancel a hook to prevent it from running in the future.
• Removed debug prints in CloseAllDocuments.
• The build output is now cleaner and is automated (internal).
• Migrated to rokit (internal).

New Contributor

• @kineticwallet made their first contribution in #57

Thank you @kineticwallet who completed the majority of the work for this update!

Full Changelog: v1.0.0...v1.1.0

Version 1.0.0

No external changes since release candidate 12

v1.0.0 Release Candidate 12

• Added Once hooks - hooks that only run once
• Added OpenAndUpdate method
• Fixed a bug that would cause BindToClose to yield for an extra second more than needed

Version 1.0.0-rc.11

• Added Fail hooks
• Fixed a bug where failed open would result in CloseAllDocuments yielding indefinitely