Skip to content

@tavora/sdk / watchOverlay

Function: watchOverlay() ​

watchOverlay(fn): Unsubscribe

Defined in: packages/sdk/src/index.ts:657

For the manifest's overlay page, which runs in streaming software rather than in Tavora: calls fn with what the module published for this overlay (overlay.publish), straight away and on every change, and with null while there is nothing to show. It reconnects by itself when Tavora restarts. Returns a function that stops it.

Parameters ​

fn ​

(state) => void

Returns ​

Unsubscribe

For Tavora 0.23.9 and @tavora/sdk 0.3.3. Code under the MIT License. The Tavora name and logo are not covered by it.