From a975680600fc54f54192d582d103609d6d531e65 Mon Sep 17 00:00:00 2001 From: beefchimi Date: Sat, 27 Jan 2024 14:35:14 -0500 Subject: [PATCH] :memo: [Report] Add changeset --- .changeset/blue-jank-crime.md | 5 +++++ .changeset/thick-oranges-exercise.md | 5 +++++ pkg/earwurm/MIGRATION.md | 11 +++++++++++ 3 files changed, 21 insertions(+) create mode 100644 .changeset/blue-jank-crime.md create mode 100644 .changeset/thick-oranges-exercise.md diff --git a/.changeset/blue-jank-crime.md b/.changeset/blue-jank-crime.md new file mode 100644 index 0000000..037ce92 --- /dev/null +++ b/.changeset/blue-jank-crime.md @@ -0,0 +1,5 @@ +--- +"earwurm": minor +--- + +Remove timed auto-suspend in favour of exposing `.suspend() / .resume()` methods on `Earuwrm`. diff --git a/.changeset/thick-oranges-exercise.md b/.changeset/thick-oranges-exercise.md new file mode 100644 index 0000000..c58550e --- /dev/null +++ b/.changeset/thick-oranges-exercise.md @@ -0,0 +1,5 @@ +--- +"earwurm": minor +--- + +New `play` event available on `Earwurm` instance. diff --git a/pkg/earwurm/MIGRATION.md b/pkg/earwurm/MIGRATION.md index cc9a7f3..902ec7d 100644 --- a/pkg/earwurm/MIGRATION.md +++ b/pkg/earwurm/MIGRATION.md @@ -1,5 +1,16 @@ # Earwurm Migration Guide +## 0.9.0 + +- Removed the “timed auto-suspend” behaviour. + - With the new `play` event, it is now easy for consumers to specify this behaviour themselves. + - See the `Examples` documentation for some insight. + - PR for code change: +- While there is no more “timed auto-suspend”, the `Earwurm` will attempt to optimistically `suspend` whenever: + - All `Stacks` have been removed from the `Earwurm`. instance. + - `.stop()` has been called on the `Earwurn` instance. +- Will now auto-resume a `suspended` state when `.play()` is called on a `Sound`. + ## 0.7.0 - Replaced the `fadeMs?: number` option for `Earwurm`, `Stack`, and `Sound` with a simpler `transitions?: boolean` option.