package
0.0.0-20240227044129-7256b7516e18
Repository: https://github.com/thusharprakash/go-orbit-db.git
Documentation: pkg.go.dev

# Structs

CreateDBOptions lists the arguments to create a store.
No description provided by the author
DetermineAddressOptions Lists the arguments used to determine a store address.
No description provided by the author
No description provided by the author
EventPubSubJoin Is an event triggered when a peer joins the channel.
EventPubSubLeave Is an event triggered when a peer leave the channel.
EventPubSubMessage Indicates a new message posted on a pubsub topic.
EventPubSubPayload An event received on new messages.
No description provided by the author
NewStoreOptions Lists the options to create a new store.
No description provided by the author
StreamOptions Defines the parameters that can be given to the Stream function of an EventLogStore.

# Interfaces

BaseOrbitDB Provides the main OrbitDB interface used to open and create stores.
No description provided by the author
No description provided by the author
DocumentStore A type of store that provides a document store.
EventLogStore A type of store that provides an append only log.
KeyValueStore A type of store that provides a key value store.
No description provided by the author
OrbitDB Provides an OrbitDB interface with the default access controllers and store types.
OrbitDBDocumentStore An OrbitDB instance providing a Document store.
OrbitDBDocumentStoreProvider Exposes a method providing a document store.
OrbitDBKVStore An OrbitDB instance providing a KeyValue store.
OrbitDBKVStoreProvider Exposes a method providing a key value store.
OrbitDBLogStore An OrbitDB instance providing an Event Log store.
OrbitDBLogStoreProvider Exposes a method providing an event log store.
No description provided by the author
PubSubTopic is a pub sub subscription to a topic.
Store Defines the operations common to all stores types.
No description provided by the author
StoreIndex Index contains the state of a datastore, ie.

# Type aliases

AccessControllerConstructor Required prototype for custom controllers constructors.
No description provided by the author
IndexConstructor Defines the expected constructor for a custom index.
OnWritePrototype Defines the callback function prototype which is triggered on a write.
StoreConstructor Defines the expected constructor for a custom store.