create-shared-composable

Share one instance of a composable between all simultaneously mounted callers, reference-counted by their effect scopes.

Usage

import { createSharedComposable } from "@vizejs/composable/create-shared-composable";

Runtime contract

API

createSharedComposable

Share one instance of a composable between all simultaneously mounted callers, reference-counted by their effect scopes. The first caller creates the instance inside a detached scope using its arguments (later callers' arguments are ignored while it lives). When the last subscribing scope stops, the instance's scope is stopped and the next call starts fresh. Calls outside any effect scope subscribe permanently. On the server every call gets its own instance unless shareOnServer is set, so request state never leaks.

function createSharedComposable<Arguments extends readonly unknown[], Result>( composable: (...args: Arguments) => Result, options: CreateSharedComposableOptions = {}, ): (...args: Arguments) => Result

const useSharedMouse = createSharedComposable(useMouse);

Types

CreateSharedComposableOptions

Options for createSharedComposable.