subscription.off()

Ends a subscription returned by puter.events.onLocal(). The handler stops being called immediately, and the server is told if the connection is still open.

Ending a subscription counts toward its own unsubscribe rate limit, not the subscribe one. Over that limit off() still resolves and the handler still stops, but the server may keep the subscription until the connection closes, and a warning is logged to the console.

When the last subscription on this client ends, the events connection closes.

Syntax

subscription.off()

Parameters

None.

Return value

A Promise that resolves when the subscription is gone. It never rejects: calling off() twice, or after the connection dropped, does nothing.

Examples

Watch a directory, then stop watching it

<html>
<body>
    <script src="https://js.puter.com/v2/"></script>
    <script>
        (async () => {
            const dir = puter.randName();
            await puter.fs.mkdir(dir);

            const sub = await puter.events.onLocal(`fs:${dir}`, ({ event }) => {
                puter.print(`${event.op}: ${event.path}<br>`);
            });

            await puter.fs.write(`${dir}/first.txt`, 'delivered');

            // Give the first change time to arrive, then stop listening
            setTimeout(async () => {
                await sub.off();
                puter.print('stopped listening<br>');

                // Nothing below is delivered
                await puter.fs.write(`${dir}/second.txt`, 'not delivered');
            }, 2000);
        })();
    </script>
</body>
</html>