usePeerborne
usePeerborne<
DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey>(privateKey,publicKey,provider,changesSerializer,syncMessageSerializer,loadMessageSerializer,authProvider,aclProvider,keychainProvider,config?):Peerborne<DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey> |undefined
Defined in: hooks.ts:95
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”privateKey
Section titled “privateKey”PrivateKey | undefined
publicKey
Section titled “publicKey”PublicKey | undefined
provider
Section titled “provider”CRDTProvider<DocType, ChangesType, ChangeFnType>
changesSerializer
Section titled “changesSerializer”ChangesSerializer<ChangesType>
syncMessageSerializer
Section titled “syncMessageSerializer”SyncMessageSerializer<ChangesType>
loadMessageSerializer
Section titled “loadMessageSerializer”LoadMessageSerializer
authProvider
Section titled “authProvider”AuthProvider<PrivateKey, PublicKey, DocumentKey>
aclProvider
Section titled “aclProvider”ACLProvider<ChangesType, PublicKey>
keychainProvider
Section titled “keychainProvider”KeychainProvider<ChangesType, DocumentKey>
config?
Section titled “config?”PeerborneConfig
Returns
Section titled “Returns”Peerborne<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey> | undefined