PeerborneNode
Defined in: packages/core/src/peerborne-node.ts:148
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
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PeerborneNode<
DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey>(nodeKey,nodePublicKey,provider,changesSerializer,syncMessageSerializer,loadMessageSerializer,authProvider,aclProvider,keychainProvider,config):PeerborneNode<DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey>
Defined in: packages/core/src/peerborne-node.ts:175
Parameters
Section titled “Parameters”nodeKey
Section titled “nodeKey”PrivateKey
nodePublicKey
Section titled “nodePublicKey”PublicKey
provider
Section titled “provider”CRDTProvider<DocType, ChangesType, ChangeFnType>
changesSerializer
Section titled “changesSerializer”ChangesSerializer<ChangesType>
syncMessageSerializer
Section titled “syncMessageSerializer”SyncMessageSerializer<ChangesType>
loadMessageSerializer
Section titled “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”Returns
Section titled “Returns”PeerborneNode<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey>
Properties
Section titled “Properties”authProvider
Section titled “authProvider”
readonlyauthProvider:AuthProvider<PrivateKey,PublicKey,DocumentKey>
Defined in: packages/core/src/peerborne-node.ts:182
changesSerializer
Section titled “changesSerializer”
readonlychangesSerializer:ChangesSerializer<ChangesType>
Defined in: packages/core/src/peerborne-node.ts:179
config
Section titled “config”
readonlyconfig:PeerborneConfig
Defined in: packages/core/src/peerborne-node.ts:192
loadMessageSerializer
Section titled “loadMessageSerializer”
readonlyloadMessageSerializer:LoadMessageSerializer
Defined in: packages/core/src/peerborne-node.ts:181
provider
Section titled “provider”
readonlyprovider:CRDTProvider<DocType,ChangesType,ChangeFnType>
Defined in: packages/core/src/peerborne-node.ts:178
syncMessageSerializer
Section titled “syncMessageSerializer”
readonlysyncMessageSerializer:SyncMessageSerializer<ChangesType>
Defined in: packages/core/src/peerborne-node.ts:180
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get swarm():
Peerborne<DocType,ChangesType,ChangeFnType,PrivateKey,PublicKey,DocumentKey>
Defined in: packages/core/src/peerborne-node.ts:164
Returns
Section titled “Returns”Peerborne<DocType, ChangesType, ChangeFnType, PrivateKey, PublicKey, DocumentKey>
Methods
Section titled “Methods”start()
Section titled “start()”start():
Promise<void>
Defined in: packages/core/src/peerborne-node.ts:208
Returns
Section titled “Returns”Promise<void>