usePeerborneDocumentState
usePeerborneDocumentState<
DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey>(peerborne,documentPath,originFilter?,initialization?): [DocType|undefined, (fn,message?) =>void, {addReader: (user,readerKemPublicKey) =>Promise<void>;addWriter: (user) =>Promise<void>;readers:PublicKey[];removeReader: (user) =>Promise<void>;removeWriter: (user,options?) =>Promise<void>;setKemKeyPair: (keyPair) =>Promise<void>;writers:PublicKey[]; },Error|undefined]
Defined in: hooks.ts:149
Type Parameters
Section titled “Type Parameters”DocType
Section titled “DocType”DocType
ChangesType
Section titled “ChangesType”ChangesType
ChangeFnType
Section titled “ChangeFnType”ChangeFnType
PrivateKey
Section titled “PrivateKey”PrivateKey
PublicKey
Section titled “PublicKey”PublicKey
DocumentKey
Section titled “DocumentKey”DocumentKey
Parameters
Section titled “Parameters”peerborne
Section titled “peerborne”Peerborne<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey>
documentPath
Section titled “documentPath”string
originFilter?
Section titled “originFilter?”"all" | "remote" | "local"
initialization?
Section titled “initialization?”PeerborneDocumentInitialization = 'open'
Returns
Section titled “Returns”[DocType | undefined, (fn, message?) => void, { addReader: (user, readerKemPublicKey) => Promise<void>; addWriter: (user) => Promise<void>; readers: PublicKey[]; removeReader: (user) => Promise<void>; removeWriter: (user, options?) => Promise<void>; setKemKeyPair: (keyPair) => Promise<void>; writers: PublicKey[]; }, Error | undefined]