Function useDocument

  • useDocument<T>(
        url: MaybeAccessor<undefined | AutomergeUrl>,
        options?: UseDocHandleOptions,
    ): [Accessor<Doc<T> | undefined>, Resource<DocHandle<T> | undefined>]

  • get a fine-grained live view of a document, and its handle, from a URL.

    Type Parameters

    • T

    Parameters

    • url: MaybeAccessor<undefined | AutomergeUrl>

      a function that returns a url

    • Optionaloptions: UseDocHandleOptions

    Returns [Accessor<Doc<T> | undefined>, Resource<DocHandle<T> | undefined>]

Settings

Member Visibility