From fb3fa76f2303a79f3a7ba313164497151f9f5f31 Mon Sep 17 00:00:00 2001 From: Curtis Dulmage Date: Sat, 27 Jan 2024 18:56:47 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20[Docs]=20Add=20note=20about=20pl?= =?UTF-8?q?ay=20event=20in=20api.md=20(#81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/api.md b/docs/api.md index 144ed06..1d62cf1 100644 --- a/docs/api.md +++ b/docs/api.md @@ -124,6 +124,11 @@ manager.activeEvents; // “unlocked” right away. (event: 'state', listener: (current: ManagerState) => void) +// Event called whenever `manager.playing` switches from +// `true -> false` (and vice-versa). Useful for when you +// just want to be notified whenever that value changes. +(event: 'play', listener: (active: boolean) => void) + // Event called whenever the `keys` property changes. This is useful // to subscribe to changes in the internal “stack library”. (event: 'library', listener: (newKeys: StackId[], oldKeys: StackId[]) => void)