Skip to content

Latest commit

 

History

History
94 lines (59 loc) · 5.81 KB

CHANGELOG.md

File metadata and controls

94 lines (59 loc) · 5.81 KB
Raw

3.1.1 (April 3, 2024)

  • Fixed incorrect TypeScript definition for async derived (#25)
  • Now supports Svelte 5 (-next.94 and later)

In Svelte 5, this package does not use runes and continues to use the original writable store interface, which is not deprecated. I may release a separate package that uses runes.

3.1.0 (June🏳️‍🌈 14, 2023)

With this release, I am committing to supporting Svelte v4 through its prereleases and beyond! If this is helpful for you, tip the maintainer!

3.0.1 (published as @next December 24🎄, 2022; @latest January 11, 2023)

  • Changed: reflect now has only one form with signature (reflecting, old). It can no longer set origins asynchronously. (#23)
  • Typescript improvements:
    • When origins is an array, values returned by reflect must be compatible with its stores, just as when origins is a single store (#19)
    • writableDerived is reduced from 8 to 2 signatures, making TypeScript error messages more useful

(Version 3.0.0 introduced the above changes but lacked some updates to readme example code and the JSDocs.)

2.1.6 (December 24🎄, 2022)

No behavior changes.

  • Announce v3 and deprecate asynchronous reflect

2.1.5 (July 3, 2022)

No behavior changes.

  • Specify package.json's default conditional export last, resolving errors with tools like Webpack that strictly require it (#21)

2.1.4 (June🏳️‍🌈 22, 2022)

  • Fixed derive not getting called when an origin was set by its own subscription in response to reflect (#18)
  • TypeScript changes (#19):
    • Using a single origin store now requires it implement the set method from Svelte's Writable type
    • Improved definitions of reflect to help TypeScript choose the correct writableDerived overload
    • When origins is an array, the type reflect can set with has been loosened to any[]. This is a temporary measure to reduce undecipherable TypeScript errors.
    • Stores passed to propertyStore are no longer required to have an update method
  • Fixed links meant to point to specific sections of the Svelte documentation in the readme and JSDocs

2.1.3 (March 20, 2022)

No behavioral changes.

  • TypeScript fully supported (thanks, qu1ncyk!)

2.1.2 (November 14, 2021)

  • Fixed reflect not getting the latest value after a subscription updates its own store in Svelte >=3.6.9 (#13)
  • Documented in the readme & JSDocs that propertyStore accepts numerical propNames (though this is newly-documented, it's in a SemVer-patch release to indicate it's worked since 2.1.0) (#12)
  • JSDocs now use Markdown [links] instead of JSDoc {@link}s, working around VSCode bugs with the latter

2.1.1 (November 22, 2020)

No behavioral changes.

  • Added repository, exports, & sideEffects fields to package.json

2.1.0 (July 24, 2020)

  • Added: New export propertyStore, a writableDerived wrapper for making a derived store from a stored object's property with less boilerplate (#5)
  • Added: Named export writableDerived is an alias for the default export, allowing you to get both exports with names if you so choose
  • JSDocs added. TypeScript can get type info from JSDocs, so TypeScript is now partially supported!

2.0.1 (June 14, 2019)

  • Fixed: Setting/updating a store to a new primitive value, then setting/updating the store to the same value from its subscriptions would prevent reflect from being called
  • Fixed: Setting/updating a subscriptionless store to the primitive value it already had could cause a spurious reflect call

2.0.0 (June 13, 2019)

  • Changed: reflect is now either a function with signature (reflecting, set) or an object with interface { withOld(reflecting, old, set) }. Async-ness is determined by whether the function accepts a set parameter, just as for the derive callback.
  • Changed: The reflect callback now runs after subscriptions. Additional set/update calls while running subscriptions result in reflect being called only once with the most recent value.
  • Changed: Changes to which operations cause a subscription-less writableDerived to subscribe-then-unsubscribe to all origins:
    • set method calls now do so
    • Getting old origin values in reflect no longer does so
  • Optimization: Origin values are no longer kept if reflect will not need them
  • Optimization: Participates in Svelte v3.5.0's diamond dependencies solution (downstream only; there is no diamond dependency handling for reflecting values back to their sources)
  • Optimization: No more internal writable store; the derived is the only internal store remaining

If this update was useful for you, show your appreciation with money, kind words, or a job!

1.0.1 (June 7, 2019)

  • Fixed: First subscription was getting its first call before derive ran
  • Optimization: Internal derived store is no longer set; all sets go to the internal writable store (replaced with a different optimization in 2.0.0)

1.0.0 (June 2, 2019)

  • Initial release