Skip to content

CHANGELOG.md

Latest commit

 

History

History
211 lines (150 loc) · 9.48 KB

CHANGELOG.md

File metadata and controls

211 lines (150 loc) · 9.48 KB
Raw

Changelog (pre-v0.11.0)

Breaking changes in bold.

For versions v0.11.0 and up, see laminar.dev/blog

v0.10.2 – Sep 2020

  • New: ConcurrentStreamStrategy

v0.10.1 – Sep 2020

  • New: EventStream.periodic and PeriodicEventStream
  • New: EventStream.fromJsPromise and Signal.fromJsPromise

News:

v0.10.0 – Aug 2020

  • Naming: fold -> foldLeft, foldRecover -> foldLeftRecover, FoldSignal -> FoldLeftSignal
  • Naming: composeChangesAndInitial -> composeAll
  • New: splitOne and splitOneIntoSignals methods
    • Works just like split and splitIntoSignals but operates on observables of A, not M[A], so this way you can split observables of individual records rather than observables of (e.g.) lists of records.

v0.9.2 – Jul 2020

  • Fix: EventBus.emit signature overly restrictive

v0.9.1 – Jul 2020

  • Fix: throttle operator behaved more like debounce, it was not emitting until the parent stopped emitting for intervalMillis. It behaves as advertised now. (#34)
  • New: Observer.combine(observer1, observer2, ...) factory
  • New: observer.contracollect { case Foo => bar } operator
  • New: EventBus.emit and EventBus.emitTry
    • Just convenience wrappers over WriteBus methods

v0.9.0 – Mar 2020

  • Build: Upgrade to scala-js-dom 1.0.0
    • Does not affect Airstream itself, just be aware that it's not compatible with scala-js-dom v0.9.8
  • API: debugLog operator now prints with println instead of dom.console.log
  • New: debugLogJs operator that prints with dom.console.log

v0.8.0 – Mar 2020

  • New: Dynamic Ownership
    • Flagship feature of this release. Dynamic ownership makes it easier to build complex Laminar-style ownership lifetimes with the ability to re-activate subscriptions after they were deactivated. If you're building a DOM manipulation library this will be very handy. See how Laminar v0.8 uses this feature for inspiration.
    • This feature builds on top of regular Ownership so it's not a breaking change in itself, except for the incidental breaking changes listed below.
  • API: Merge Owned into Subscription
    • Several API changes including new cleanup param instead of an onKilled method (yay composition) – see how EventBusSource uses it. Also moveSubscription into ownership package
    • Subscription constructor is now public
    • Migration: Replace usages of Owned with Subscription and adapt to the slightly different API.
  • API: Eliminate EventBusSource, replace by Subscription
  • API: Privatize EventBusStream constructor
  • API: Trying to kill an already dead Subscription now throws an exception
  • New: OptionSplittable – you can now split observables of Option[A] as if it's a list of zero-to-one items
  • New: WriteBus.emit and WriteBus.emitTry methods to send events to multiple WriteBus-es in a single transaction (essentially, Var.set but for streams)
  • New: EventStream.empty, a stream that never emits any events
  • Build: Note that this release is version 0.8.0, not 0.8 as I would have named it before

v0.7.2 – Nov 2019

  • Build: Scala 2.13 Support – thanks, @megri!

v0.7.1 – Aug 2019

  • API: Simplify combineWith type signature (return EventStream / Signal types instead of more specific subtypes)
    • Note: very small chance of breakage: this will affect you if you relied on the return type of these methods being unnecessarily specific (CombineSignal2 / CombineEventStream2). This is unlikely because these internal types don't offer you any functionality.
  • API: Move mapTo and mapToValue methods from EventStream to Observable
  • New: WriteBus.contracomposeWriter – thanks, @vic!
  • New: Add startWith* aliases for toSignal* methods on EventStream
  • New: unsafeRethrowErrorCallback and delayedRethrowErrorCallback for error handling

v0.7 – Apr 2019

  • API: fromValue, fromSeq, and fromTry event streams now require emitOnce param
  • API: toSignal, toSignalWithTry arguments are now passed by name
    • This means that these values will now be evaluated only if / when the resulting Signal is started for the first time.
  • API: Move debugging operators from Debug object into Observable trait
  • API: Change param name of delay operator from intervalMillis to ms
  • New: delaySync operator to control the relative order of streams emission within the same transaction
  • New: flatMap (#20) – thanks, @yurique!
    • API: FlattenObservable type params changed, might break your custom implementations – see diff
  • New: SwitchSignalStrategy to flatten signals of signals
  • New: split and splitIntoSignals operators
    • Powerful operators letting you split any observable into multiple streams or signals. Provide an easier way to efficiently render children nodes in Laminar.
  • New: composeChanges and composeChangesAndInitial operators for Signal
  • New: Report failures of unhandled error callbacks

v0.6 – Does not Exist

  • Skipping this version to align versions with Laminar

v0.5.2 – Jan 2019

  • API: Make Val a StrictSignal (it already behaved like one)

v0.5.1 – Dec 2018

  • API: Make FutureSignal a StrictSignal (it already behaved like one)

v0.5 – Dec 2018

  • API: Eliminate the whole concept of State #13
    • State and StateVar are no more. RIP
    • Merge MemoryObservable into Signal
    • Merge LazyObservable into Observable
    • Remove toLazy method as all observables are now lazy
    • Migration guide
      • Use Signal instead of State and MemoryObservable. This is NOT a drop in replacement as State was not lazy. Make sure you have observers (internal or external) on all Signals that would be replacing State, or else they won't run. Consult the updated documentation for a reminder on Signal semantics.
      • For Signal alternatives to State's now() / tryNow() methods, see the Getting Signal's current value section in the new docs.
      • Use Observable instead of LazyObservable.
      • Use Var instead of StateVar.
      • Use toSignal instead of toState.
      • Remove invocations of toLazy method, they are not needed anymore.
  • API: Make Var and its signal strict (not lazy)
    • Var does not provide a WriteBus anymore, only an Observer
    • Var now exposes now and tryNow methods, as does its signal
    • See Var docs for details
  • API: Make SignalViewer a Signal itself
    • A StrictSignal, to be precise
  • API: Remove flatMap method
    • Use map(...).flatten
    • I don't have time to sort out type inference and other stuff needed to get flatMap to work nicely.
  • New: Update Vars using (currentValue => nextValue) functions
    • New methods on Var instances: set, setTry, update, tryUpdate
  • New: Batch update Vars in a single transaction
    • Companion object methods: Var.set, Var.setTry, Var.update, Var.tryUpdate
    • See new Var docs for details

v0.4.1 – Dec 2018

  • Fix: NPE from errors unhandled by recover partial function

v0.4 – Nov 2018

  • New: Error Handling – see whole new section in docs
  • API: a few breaking changes for those who extend Airstream classes
    • A bunch of class / trait member fields are now Try[A] instead of A
    • Split fire into fireValue & fireError, etc.
    • By and large this does not affect existing Airstream usage, just customization by subclassing
  • API: Observable.removeObserver and Transaction.removeExternalObserver are now private (#10)
  • Build: Drop Scala 2.11 support
  • New: SignalViewer
    • This serves as a warning about my intention to deprecate and eventually remove the entirety of the State type in Airstream. Its strictness has not proved useful, and yet has plenty of drawbacks. See Laminar#37 for details. If you want to speak up against that, now is the time.
  • New: Ref performance util (experimental)

v0.3 – Sep 2018

  • Naming: Observer.map -> Observer.contramap
  • Naming: WriteBus.mapWriter -> WriteBus.contramapWriter
  • API: EventStream.mapTo now accepts value by name; previous behaviour available using mapToValue method
  • API: Observable.flatten now needs a FlattenStrategy except for SwitchEventStream which is provided implicitly as a default
  • New: Integration with Futures. EventStream.fromFuture, Signal.fromFuture, State.fromFuture, SwitchFutureStrategy, ConcurrentFutureStrategy, OverwriteFutureStrategy
  • New: LazyObservable.flatMap (available via implicits)
  • New: LazyObservable.map returns a more specific type

v0.2 – Apr 2018

  • API: Signal only fires if nextValue != prevValue
  • Naming: Var -> StateVar
  • New: Make Val.now() public
  • New: signal.Var
  • Fix: Ensure Signal's initialValue has been evaluated onStart

v0.1 – Apr 2018

Initial release. First version extracted from Laminar repo.