Function useDocument

  • useDocument<T>(id?): [Doc<T> | undefined, ((changeFn, options?) => void)]

  • A hook which returns a document identified by a URL and a function to change the document.

    Type Parameters

    • T

    Parameters

    Returns [Doc<T> | undefined, ((changeFn, options?) => void)]

    a tuple of the document and a function to change the document. The document will be undefined if the document is not available in storage or from any peers

    Remarks

    This requires a RepoContext to be provided by a parent component.

Settings

Member Visibility

Theme