From 42aff7eaa49a7e7d2b8039e4e10cb347a8b5fa44 Mon Sep 17 00:00:00 2001 From: "aegir[bot]" Date: Tue, 7 May 2024 18:58:19 +0000 Subject: [PATCH] docs: update documentation [skip ci] --- assets/highlight.css | 42 ++++++++++++++------- classes/database.Database.html | 8 ++-- classes/index.Address.html | 12 +++--- classes/index.Entry.html | 4 +- classes/index.Identity.html | 4 +- classes/index.Keyvalue.html | 4 +- classes/index.Manifest.html | 12 +++--- classes/index.Playable.html | 4 +- classes/index.StaticAccess.html | 4 +- classes/welo.Welo.html | 10 ++--- functions/index.basalEntry.html | 2 +- functions/index.basalIdentity.html | 2 +- functions/index.bootstrapReplicator.html | 2 +- functions/index.keyvalueStore.html | 2 +- functions/index.liveReplicator.html | 2 +- functions/index.pubsubReplicator.html | 2 +- functions/index.staticAccess-1.html | 2 +- functions/welo.createWelo.html | 2 +- index.html | 9 +++-- interfaces/interface.ClosedEmit.html | 4 +- interfaces/interface.ComponentProtocol.html | 4 +- interfaces/interface.Components.html | 4 +- interfaces/interface.Config.html | 4 +- interfaces/interface.DbComponents.html | 4 +- interfaces/interface.DbConfig.html | 4 +- interfaces/interface.DbEvents.html | 4 +- interfaces/interface.DbOpen.html | 4 +- interfaces/interface.Determine.html | 4 +- interfaces/interface.Events.html | 4 +- interfaces/interface.OpenOptions.html | 4 +- interfaces/interface.OpenedEmit.html | 4 +- interfaces/interface.WeloInit.html | 4 +- modules/database.html | 2 +- modules/index-1.html | 2 +- modules/index.html | 2 +- modules/interface.html | 2 +- modules/welo.html | 2 +- types/interface.GossipHelia.html | 2 +- types/interface.GossipLibp2p.html | 2 +- types/interface.GossipServiceMap.html | 2 +- 40 files changed, 107 insertions(+), 90 deletions(-) diff --git a/assets/highlight.css b/assets/highlight.css index f64dbab0..daf16804 100644 --- a/assets/highlight.css +++ b/assets/highlight.css @@ -1,20 +1,24 @@ :root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; + --light-hl-0: #0070C1; + --dark-hl-0: #4FC1FF; --light-hl-1: #000000; --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #AF00DB; - --dark-hl-3: #C586C0; - --light-hl-4: #001080; - --dark-hl-4: #9CDCFE; - --light-hl-5: #008000; - --dark-hl-5: #6A9955; - --light-hl-6: #0000FF; - --dark-hl-6: #569CD6; - --light-hl-7: #0070C1; - --dark-hl-7: #4FC1FF; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #000000; + --dark-hl-3: #C8C8C8; + --light-hl-4: #008000; + --dark-hl-4: #6A9955; + --light-hl-5: #0000FF; + --dark-hl-5: #569CD6; + --light-hl-6: #A31515; + --dark-hl-6: #CE9178; + --light-hl-7: #CD3131; + --dark-hl-7: #F44747; + --light-hl-8: #795E26; + --dark-hl-8: #DCDCAA; + --light-hl-9: #AF00DB; + --dark-hl-9: #C586C0; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -28,6 +32,8 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } } @@ -40,6 +46,8 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } } @@ -52,6 +60,8 @@ --hl-5: var(--light-hl-5); --hl-6: var(--light-hl-6); --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } @@ -64,6 +74,8 @@ --hl-5: var(--dark-hl-5); --hl-6: var(--dark-hl-6); --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } @@ -75,4 +87,6 @@ .hl-5 { color: var(--hl-5); } .hl-6 { color: var(--hl-6); } .hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } pre, code { background: var(--code-background); } diff --git a/classes/database.Database.html b/classes/database.Database.html index 798f95a6..8681a350 100644 --- a/classes/database.Database.html +++ b/classes/database.Database.html @@ -1,5 +1,5 @@ Database | welo

Class Database

Database Class

-

Hierarchy (view full)

Constructors

Hierarchy (view full)

Constructors

Properties

Constructors

Properties

#onStoreUpdate: ((this) => void)

Type declaration

    • (this): void
    • Parameters

      Returns void

components: DbComponents
datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

Type declaration

    Type declaration

      Type declaration

        Type declaration

          Type declaration

            Type declaration

              Type declaration

                Type declaration

                  Type declaration

                    Type declaration

                      identity: IdentityInstance<any>
                      manifest: Manifest
                      replica: Replica
                      replicators: Replicator[]

                      Accessors

                      Methods

                      • Close the Database

                        +

                      Constructors

                      Properties

                      #onStoreUpdate: ((this) => void)

                      Type declaration

                        • (this): void
                        • Parameters

                          Returns void

                      components: DbComponents
                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                      Type declaration

                        Type declaration

                          Type declaration

                            Type declaration

                              Type declaration

                                Type declaration

                                  Type declaration

                                    Type declaration

                                      Type declaration

                                        Type declaration

                                          identity: IdentityInstance<any>
                                          manifest: Manifest
                                          replica: Replica
                                          replicators: Replicator[]

                                          Accessors

                                          Methods

                                          • Close the Database

                                            Welo database factory listens for the closed method to be called to manage lifecycles of databases it's managing.

                                            -

                                            Returns Promise<void>

                                          • Open a Database

                                            Welo Database factory uses this method, and provides the modules needed, to return databases from its open instance method.

                                            Parameters

                                            • options: DbOpen

                                              Contains properties and modules for the database to use

                                              -

                                            Returns Promise<Database>

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Returns Promise<Database>

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/index.Address.html b/classes/index.Address.html index 3dcb3362..ab5e5626 100644 --- a/classes/index.Address.html +++ b/classes/index.Address.html @@ -1,19 +1,19 @@ Address | welo

                                          Class Address

                                          Manifest Address

                                          May also be referred to as the database address. It is a CID with a prefix that says it's an hldb manifest.

                                          -

                                          Constructors

                                          Constructors

                                          Properties

                                          Methods

                                          Constructors

                                          Properties

                                          cid: CID<unknown, number, number, Version>

                                          Methods

                                          • Checks if two addresses are equal

                                            +

                                          Constructors

                                          Properties

                                          cid: CID<unknown, number, number, Version>

                                          Methods

                                          • Checks if two addresses are equal

                                            Similar to CID.equals.

                                            Parameters

                                            Returns boolean

                                          • Converts the Address to a string

                                            +

                                          Returns boolean

                                          • Converts the Address to a string

                                            Parameters

                                            • base: Codec<"base32", "b"> = base32

                                              the base encoding to use

                                              -

                                            Returns string

                                          • Optimistically coerce values into an Address

                                            +

                                          Returns string

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Returns null | Address

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/index.Entry.html b/classes/index.Entry.html index 8a562d06..278a623f 100644 --- a/classes/index.Entry.html +++ b/classes/index.Entry.html @@ -1,4 +1,4 @@ -Entry | welo

                                          Class Entry

                                          Implements

                                          Constructors

                                          constructor +Entry | welo

                                          Class Entry

                                          Implements

                                          Constructors

                                          Properties

                                          auth block cid @@ -8,4 +8,4 @@ refs sig tag -

                                          Constructors

                                          Properties

                                          auth: CID<unknown, number, number, Version>
                                          block: BlockView<SignedEntry, number, number, 1>
                                          cid: CID<unknown, number, number, Version>
                                          identity: IdentityInstance<any>
                                          next: CID<unknown, number, number, Version>[]
                                          payload: any
                                          refs: CID<unknown, number, number, Version>[]

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Constructors

                                          Properties

                                          auth: CID<unknown, number, number, Version>
                                          block: BlockView<SignedEntry, number, number, 1>
                                          cid: CID<unknown, number, number, Version>
                                          identity: IdentityInstance<any>
                                          next: CID<unknown, number, number, Version>[]
                                          payload: any
                                          refs: CID<unknown, number, number, Version>[]

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/index.Identity.html b/classes/index.Identity.html index 406b9434..a13615fa 100644 --- a/classes/index.Identity.html +++ b/classes/index.Identity.html @@ -1,4 +1,4 @@ -Identity | welo

                                          Class Identity

                                          Implements

                                          Constructors

                                          constructor +Identity | welo

                                          Class Identity

                                          Implements

                                          Constructors

                                          Properties

                                          auth block id @@ -8,4 +8,4 @@ sig

                                          Methods

                                          Constructors

                                          Properties

                                          auth: CID<unknown, number, number, Version>
                                          block: BlockView<IdentityValue, number, number, 1>
                                          name?: string
                                          pubkey: PublicKey

                                          Methods

                                          Generated using TypeDoc

                                          \ No newline at end of file +

                                          Constructors

                                          Properties

                                          auth: CID<unknown, number, number, Version>
                                          block: BlockView<IdentityValue, number, number, 1>
                                          name?: string
                                          pubkey: PublicKey

                                          Methods

                                          Generated using TypeDoc

                                          \ No newline at end of file diff --git a/classes/index.Keyvalue.html b/classes/index.Keyvalue.html index a863e52e..9e21f49e 100644 --- a/classes/index.Keyvalue.html +++ b/classes/index.Keyvalue.html @@ -1,5 +1,5 @@ Keyvalue | welo

                                          Class Keyvalue

                                          Implements Libp2p's Startable interface for easy reuse with async code.

                                          -

                                          Hierarchy (view full)

                                          Implements

                                          Constructors

                                          Hierarchy (view full)

                                          Implements

                                          Constructors

                                          Properties

                                          Constructors

                                          Properties

                                          _index: null | Paily
                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                          Type declaration

                                            Type declaration

                                              Type declaration

                                                Type declaration

                                                  Type declaration

                                                    Type declaration

                                                      Type declaration

                                                        Type declaration

                                                          config?: Config
                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                          Type declaration

                                                            Type declaration

                                                              Type declaration

                                                                Type declaration

                                                                  Type declaration

                                                                    Type declaration

                                                                      Type declaration

                                                                        Type declaration

                                                                          Type declaration

                                                                            Type declaration

                                                                              manifest: Manifest
                                                                              replica: Replica

                                                                              Accessors

                                                                              • get creators(): {
                                                                                    del: ((key) => Del);
                                                                                    put: ((key, value) => Put);
                                                                                }
                                                                              • Returns {
                                                                                    del: ((key) => Del);
                                                                                    put: ((key, value) => Put);
                                                                                }

                                                                                • del: ((key) => Del)
                                                                                    • (key): Del
                                                                                    • Parameters

                                                                                      • key: string

                                                                                      Returns Del

                                                                                • put: ((key, value) => Put)
                                                                                    • (key, value): Put
                                                                                    • Parameters

                                                                                      • key: string
                                                                                      • value: any

                                                                                      Returns Put

                                                                              • get selectors(): {
                                                                                    entries: ((state) => (() => AsyncIterable<[string, any]>));
                                                                                    get: ((state) => ((key) => Promise<undefined | {}>));
                                                                                    keys: ((state) => (() => AsyncGenerator<string, void, unknown>));
                                                                                    values: ((state) => (() => AsyncGenerator<undefined | {}, void, unknown>));
                                                                                }
                                                                              • Returns {
                                                                                    entries: ((state) => (() => AsyncIterable<[string, any]>));
                                                                                    get: ((state) => ((key) => Promise<undefined | {}>));
                                                                                    keys: ((state) => (() => AsyncGenerator<string, void, unknown>));
                                                                                    values: ((state) => (() => AsyncGenerator<undefined | {}, void, unknown>));
                                                                                }

                                                                                • entries: ((state) => (() => AsyncIterable<[string, any]>))
                                                                                    • (state): (() => AsyncIterable<[string, any]>)
                                                                                    • Parameters

                                                                                      Returns (() => AsyncIterable<[string, any]>)

                                                                                        • (): AsyncIterable<[string, any]>
                                                                                        • Returns AsyncIterable<[string, any]>

                                                                                • get: ((state) => ((key) => Promise<undefined | {}>))
                                                                                    • (state): ((key) => Promise<undefined | {}>)
                                                                                    • Parameters

                                                                                      Returns ((key) => Promise<undefined | {}>)

                                                                                        • (key): Promise<undefined | {}>
                                                                                        • Parameters

                                                                                          • key: string

                                                                                          Returns Promise<undefined | {}>

                                                                                • keys: ((state) => (() => AsyncGenerator<string, void, unknown>))
                                                                                • values: ((state) => (() => AsyncGenerator<undefined | {}, void, unknown>))

                                                                              Methods

                                                                              Generated using TypeDoc

                                                                              \ No newline at end of file +

                                                                              Constructors

                                                                              Properties

                                                                              _index: null | Paily
                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                              Type declaration

                                                                                Type declaration

                                                                                  Type declaration

                                                                                    Type declaration

                                                                                      Type declaration

                                                                                        Type declaration

                                                                                          Type declaration

                                                                                            Type declaration

                                                                                              config?: Config
                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                              Type declaration

                                                                                                Type declaration

                                                                                                  Type declaration

                                                                                                    Type declaration

                                                                                                      Type declaration

                                                                                                        Type declaration

                                                                                                          Type declaration

                                                                                                            Type declaration

                                                                                                              Type declaration

                                                                                                                Type declaration

                                                                                                                  manifest: Manifest
                                                                                                                  replica: Replica

                                                                                                                  Accessors

                                                                                                                  • get creators(): {
                                                                                                                        del: ((key) => Del);
                                                                                                                        put: ((key, value) => Put);
                                                                                                                    }
                                                                                                                  • Returns {
                                                                                                                        del: ((key) => Del);
                                                                                                                        put: ((key, value) => Put);
                                                                                                                    }

                                                                                                                    • del: ((key) => Del)
                                                                                                                        • (key): Del
                                                                                                                        • Parameters

                                                                                                                          • key: string

                                                                                                                          Returns Del

                                                                                                                    • put: ((key, value) => Put)
                                                                                                                        • (key, value): Put
                                                                                                                        • Parameters

                                                                                                                          • key: string
                                                                                                                          • value: any

                                                                                                                          Returns Put

                                                                                                                  • get selectors(): {
                                                                                                                        entries: ((state) => (() => AsyncIterable<[string, any]>));
                                                                                                                        get: ((state) => ((key) => Promise<undefined | {}>));
                                                                                                                        keys: ((state) => (() => AsyncGenerator<string, void, unknown>));
                                                                                                                        values: ((state) => (() => AsyncGenerator<undefined | {}, void, unknown>));
                                                                                                                    }
                                                                                                                  • Returns {
                                                                                                                        entries: ((state) => (() => AsyncIterable<[string, any]>));
                                                                                                                        get: ((state) => ((key) => Promise<undefined | {}>));
                                                                                                                        keys: ((state) => (() => AsyncGenerator<string, void, unknown>));
                                                                                                                        values: ((state) => (() => AsyncGenerator<undefined | {}, void, unknown>));
                                                                                                                    }

                                                                                                                    • entries: ((state) => (() => AsyncIterable<[string, any]>))
                                                                                                                        • (state): (() => AsyncIterable<[string, any]>)
                                                                                                                        • Parameters

                                                                                                                          Returns (() => AsyncIterable<[string, any]>)

                                                                                                                            • (): AsyncIterable<[string, any]>
                                                                                                                            • Returns AsyncIterable<[string, any]>

                                                                                                                    • get: ((state) => ((key) => Promise<undefined | {}>))
                                                                                                                        • (state): ((key) => Promise<undefined | {}>)
                                                                                                                        • Parameters

                                                                                                                          Returns ((key) => Promise<undefined | {}>)

                                                                                                                            • (key): Promise<undefined | {}>
                                                                                                                            • Parameters

                                                                                                                              • key: string

                                                                                                                              Returns Promise<undefined | {}>

                                                                                                                    • keys: ((state) => (() => AsyncGenerator<string, void, unknown>))
                                                                                                                    • values: ((state) => (() => AsyncGenerator<undefined | {}, void, unknown>))

                                                                                                                  Methods

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file diff --git a/classes/index.Manifest.html b/classes/index.Manifest.html index 42bcc814..92642c4b 100644 --- a/classes/index.Manifest.html +++ b/classes/index.Manifest.html @@ -1,6 +1,6 @@ Manifest | welo

                                                                                                                  Class Manifest

                                                                                                                  Database Manifest

                                                                                                                  Manifests contain setup configuration required to participate in a Database.

                                                                                                                  -

                                                                                                                  Constructors

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  access block entry @@ -14,17 +14,17 @@ asManifest create fetch -

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  access: Protocol<string, Record<string, unknown>>
                                                                                                                  block: BlockView<ManifestData, number, number, 1>
                                                                                                                  entry: Protocol<string, Record<string, unknown>>
                                                                                                                  identity: Protocol<string, Record<string, unknown>>
                                                                                                                  meta?: any
                                                                                                                  name: string
                                                                                                                  store: Protocol<string, Record<string, unknown>>

                                                                                                                  Accessors

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  access: Protocol<string, Record<string, unknown>>
                                                                                                                  block: BlockView<ManifestData, number, number, 1>
                                                                                                                  entry: Protocol<string, Record<string, unknown>>
                                                                                                                  identity: Protocol<string, Record<string, unknown>>
                                                                                                                  meta?: any
                                                                                                                  name: string
                                                                                                                  store: Protocol<string, Record<string, unknown>>

                                                                                                                  Accessors

                                                                                                                  Methods

                                                                                                                  • Get the Manifest Tag

                                                                                                                    The manifest tag is a unique identifier for a database that is customizable. It must be globally unique like the manifest address. Since they may not exist in the encoded manifest this method can be used in any case.

                                                                                                                    Returns Uint8Array

                                                                                                                    the tag of the manifest

                                                                                                                    -

                                                                                                                  Returns null | Manifest

                                                                                                                  Returns Promise<Manifest>

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file +

                                                                                                                  Parameters

                                                                                                                  Returns Promise<Manifest>

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file diff --git a/classes/index.Playable.html b/classes/index.Playable.html index b52d1eeb..8f3a3bea 100644 --- a/classes/index.Playable.html +++ b/classes/index.Playable.html @@ -1,5 +1,5 @@ Playable | welo

                                                                                                                  Class Playable

                                                                                                                  Implements Libp2p's Startable interface for easy reuse with async code.

                                                                                                                  -

                                                                                                                  Hierarchy (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  Hierarchy (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _isStarted _starting _stopping @@ -7,4 +7,4 @@

                                                                                                                  Methods

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _isStarted: boolean
                                                                                                                  _starting: null | Promise<void>
                                                                                                                  _stopping: null | Promise<void>
                                                                                                                  lifecycle: {
                                                                                                                      starting(): Promise<void>;
                                                                                                                      stopping(): Promise<void>;
                                                                                                                  }

                                                                                                                  Type declaration

                                                                                                                  Methods

                                                                                                                  • Returns boolean

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _isStarted: boolean
                                                                                                                  _starting: null | Promise<void>
                                                                                                                  _stopping: null | Promise<void>
                                                                                                                  lifecycle: {
                                                                                                                      starting(): Promise<void>;
                                                                                                                      stopping(): Promise<void>;
                                                                                                                  }

                                                                                                                  Type declaration

                                                                                                                  Methods

                                                                                                                  • Returns boolean

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file diff --git a/classes/index.StaticAccess.html b/classes/index.StaticAccess.html index 92052e0f..9fde191f 100644 --- a/classes/index.StaticAccess.html +++ b/classes/index.StaticAccess.html @@ -1,5 +1,5 @@ StaticAccess | welo

                                                                                                                  Class StaticAccess

                                                                                                                  Implements Libp2p's Startable interface for easy reuse with async code.

                                                                                                                  -

                                                                                                                  Hierarchy (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  Hierarchy (view full)

                                                                                                                  Implements

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  config: Config
                                                                                                                  manifest: Manifest
                                                                                                                  write: Set<string>

                                                                                                                  Methods

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file +

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  config: Config
                                                                                                                  manifest: Manifest
                                                                                                                  write: Set<string>

                                                                                                                  Methods

                                                                                                                  Generated using TypeDoc

                                                                                                                  \ No newline at end of file diff --git a/classes/welo.Welo.html b/classes/welo.Welo.html index 289ac4e1..210e0fda 100644 --- a/classes/welo.Welo.html +++ b/classes/welo.Welo.html @@ -1,5 +1,5 @@ Welo | welo

                                                                                                                  Class Welo

                                                                                                                  Database Factory

                                                                                                                  -

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Hierarchy (view full)

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  Constructors

                                                                                                                  Properties

                                                                                                                  _opening: Map<string, Promise<Database>>
                                                                                                                  blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                  Type declaration

                                                                                                                    Type declaration

                                                                                                                      Type declaration

                                                                                                                        Type declaration

                                                                                                                          Type declaration

                                                                                                                            Type declaration

                                                                                                                              Type declaration

                                                                                                                                Type declaration

                                                                                                                                  components: Components
                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                  Type declaration

                                                                                                                                    Type declaration

                                                                                                                                      Type declaration

                                                                                                                                        Type declaration

                                                                                                                                          Type declaration

                                                                                                                                            Type declaration

                                                                                                                                              Type declaration

                                                                                                                                                Type declaration

                                                                                                                                                  Type declaration

                                                                                                                                                    Type declaration

                                                                                                                                                      identity: IdentityInstance<any>
                                                                                                                                                      keychain: Keychain
                                                                                                                                                      opened: Map<string, Database>
                                                                                                                                                      replicators: ReplicatorModule<Replicator, string>[]

                                                                                                                                                      Methods

                                                                                                                                                      • Deterministically create a database manifest

                                                                                                                                                        +

                                                                                                                                                      Constructors

                                                                                                                                                      Properties

                                                                                                                                                      _opening: Map<string, Promise<Database>>
                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                      Type declaration

                                                                                                                                                        Type declaration

                                                                                                                                                          Type declaration

                                                                                                                                                            Type declaration

                                                                                                                                                              Type declaration

                                                                                                                                                                Type declaration

                                                                                                                                                                  Type declaration

                                                                                                                                                                    Type declaration

                                                                                                                                                                      components: Components
                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                      Type declaration

                                                                                                                                                                        Type declaration

                                                                                                                                                                          Type declaration

                                                                                                                                                                            Type declaration

                                                                                                                                                                              Type declaration

                                                                                                                                                                                Type declaration

                                                                                                                                                                                  Type declaration

                                                                                                                                                                                    Type declaration

                                                                                                                                                                                      Type declaration

                                                                                                                                                                                        Type declaration

                                                                                                                                                                                          identity: IdentityInstance<any>
                                                                                                                                                                                          keychain: Keychain
                                                                                                                                                                                          opened: Map<string, Database>
                                                                                                                                                                                          replicators: ReplicatorModule<Replicator, string>[]

                                                                                                                                                                                          Methods

                                                                                                                                                                                          Returns Promise<Manifest>

                                                                                                                                                                                          Returns Promise<Manifest>

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.basalEntry.html b/functions/index.basalEntry.html index f39ce171..2967284a 100644 --- a/functions/index.basalEntry.html +++ b/functions/index.basalEntry.html @@ -1 +1 @@ -basalEntry | welo

                                                                                                                                                                                          Function basalEntry

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +basalEntry | welo

                                                                                                                                                                                          Function basalEntry

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.basalIdentity.html b/functions/index.basalIdentity.html index ccdfe163..888616a5 100644 --- a/functions/index.basalIdentity.html +++ b/functions/index.basalIdentity.html @@ -1 +1 @@ -basalIdentity | welo

                                                                                                                                                                                          Function basalIdentity

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +basalIdentity | welo

                                                                                                                                                                                          Function basalIdentity

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.bootstrapReplicator.html b/functions/index.bootstrapReplicator.html index a646c4c1..68eaf0cf 100644 --- a/functions/index.bootstrapReplicator.html +++ b/functions/index.bootstrapReplicator.html @@ -1 +1 @@ -bootstrapReplicator | welo

                                                                                                                                                                                          Function bootstrapReplicator

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +bootstrapReplicator | welo

                                                                                                                                                                                          Function bootstrapReplicator

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.keyvalueStore.html b/functions/index.keyvalueStore.html index 919578d4..25c62aeb 100644 --- a/functions/index.keyvalueStore.html +++ b/functions/index.keyvalueStore.html @@ -1 +1 @@ -keyvalueStore | welo

                                                                                                                                                                                          Function keyvalueStore

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +keyvalueStore | welo

                                                                                                                                                                                          Function keyvalueStore

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.liveReplicator.html b/functions/index.liveReplicator.html index 79362caa..7764628e 100644 --- a/functions/index.liveReplicator.html +++ b/functions/index.liveReplicator.html @@ -1 +1 @@ -liveReplicator | welo

                                                                                                                                                                                          Function liveReplicator

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +liveReplicator | welo

                                                                                                                                                                                          Function liveReplicator

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.pubsubReplicator.html b/functions/index.pubsubReplicator.html index b53bfb36..10b13299 100644 --- a/functions/index.pubsubReplicator.html +++ b/functions/index.pubsubReplicator.html @@ -1 +1 @@ -pubsubReplicator | welo

                                                                                                                                                                                          Function pubsubReplicator

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +pubsubReplicator | welo

                                                                                                                                                                                          Function pubsubReplicator

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/index.staticAccess-1.html b/functions/index.staticAccess-1.html index b3aa4178..6fc20c90 100644 --- a/functions/index.staticAccess-1.html +++ b/functions/index.staticAccess-1.html @@ -1 +1 @@ -staticAccess | welo

                                                                                                                                                                                          Function staticAccess

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +staticAccess | welo

                                                                                                                                                                                          Function staticAccess

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/functions/welo.createWelo.html b/functions/welo.createWelo.html index 36930063..520b6484 100644 --- a/functions/welo.createWelo.html +++ b/functions/welo.createWelo.html @@ -1,3 +1,3 @@ createWelo | welo

                                                                                                                                                                                          Function createWelo

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/index.html b/index.html index ea510443..b5eb5569 100644 --- a/index.html +++ b/index.html @@ -7,13 +7,16 @@

                                                                                                                                                                                          welo

                                                                                                                                                                                          peer-to-peer, collaborative states using Merkle-CRDTs

                                                                                                                                                                                          HLDB implementation in Typescript

                                                                                                                                                                                          -

                                                                                                                                                                                          Install

                                                                                                                                                                                          npm install welo
                                                                                                                                                                                          +

                                                                                                                                                                                          Project Status

                                                                                                                                                                                          I am currently working on https://github.com/tabcat/dd-tree which will be the core structure for the database.
                                                                                                                                                                                          It has not been simple but I am making small progress daily.
                                                                                                                                                                                          It is the hardest part of the project from a technical standpoint and I want to have a solid solution that will last.
                                                                                                                                                                                          To track this project's progress see this issue: https://github.com/hldb/welo/issues/102
                                                                                                                                                                                          -

                                                                                                                                                                                          Usage

                                                                                                                                                                                          import { createHelia } from 'helia'
                                                                                                                                                                                          import { createWelo } from 'welo'

                                                                                                                                                                                          /** look at Helia for more configuration */
                                                                                                                                                                                          const ipfs = await createHelia()

                                                                                                                                                                                          /** see more config options in the API docs */
                                                                                                                                                                                          const welo = await createWelo({ ipfs })

                                                                                                                                                                                          /** create a manifest for a keyvalue database */
                                                                                                                                                                                          const manifest = await welo.determine({
                                                                                                                                                                                          name: 'this is the databases name',
                                                                                                                                                                                          type: 'keyvalue'
                                                                                                                                                                                          })

                                                                                                                                                                                          /** open the keyvalue database */
                                                                                                                                                                                          const keyvalue = await welo.open(manifest)

                                                                                                                                                                                          /** The keyvalue API docs are not uploaded yet */

                                                                                                                                                                                          const entryCID = await keyvalue.put('key', 'value')
                                                                                                                                                                                          const value = await keyvalue.get('key')
                                                                                                                                                                                          const entryCID = await keyvalue.del('key') +

                                                                                                                                                                                          -tabcat

                                                                                                                                                                                          +

                                                                                                                                                                                          Install

                                                                                                                                                                                          npm install welo
                                                                                                                                                                                          +
                                                                                                                                                                                          +

                                                                                                                                                                                          Usage

                                                                                                                                                                                          import { createHelia } from 'helia'
                                                                                                                                                                                          import { createWelo } from 'welo'

                                                                                                                                                                                          /** look at Helia for more configuration */
                                                                                                                                                                                          const ipfs = await createHelia()

                                                                                                                                                                                          /** see more config options in the API docs */
                                                                                                                                                                                          const welo = await createWelo({ ipfs })

                                                                                                                                                                                          /** create a manifest for a keyvalue database */
                                                                                                                                                                                          const manifest = await welo.determine({
                                                                                                                                                                                          name: 'this is the databases name',
                                                                                                                                                                                          type: 'keyvalue'
                                                                                                                                                                                          })

                                                                                                                                                                                          /** open the keyvalue database */
                                                                                                                                                                                          const keyvalue = await welo.open(manifest)

                                                                                                                                                                                          /** The keyvalue API docs are not uploaded yet */

                                                                                                                                                                                          const entryCID = await keyvalue.put('key', 'value')
                                                                                                                                                                                          const value = await keyvalue.get('key')
                                                                                                                                                                                          const entryCID = await keyvalue.del('key')

                                                                                                                                                                                          Check out the tests for more usage examples for now.

                                                                                                                                                                                          API

                                                                                                                                                                                          Check out the API Docs

                                                                                                                                                                                          Examples

                                                                                                                                                                                          TodoMVC

                                                                                                                                                                                          License

                                                                                                                                                                                          This project is dual licensed under APACHE-2.0 and MIT.

                                                                                                                                                                                          Funding

                                                                                                                                                                                          Thanks to Protocol Labs for funding this project through this grant.

                                                                                                                                                                                          -

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.ClosedEmit.html b/interfaces/interface.ClosedEmit.html index eca39887..c2ca210c 100644 --- a/interfaces/interface.ClosedEmit.html +++ b/interfaces/interface.ClosedEmit.html @@ -1,2 +1,2 @@ -ClosedEmit | welo

                                                                                                                                                                                          Interface ClosedEmit

                                                                                                                                                                                          interface ClosedEmit {
                                                                                                                                                                                              address: Address;
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Properties

                                                                                                                                                                                          address: Address

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +ClosedEmit | welo

                                                                                                                                                                                          Interface ClosedEmit

                                                                                                                                                                                          interface ClosedEmit {
                                                                                                                                                                                              address: Address;
                                                                                                                                                                                          }

                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Properties

                                                                                                                                                                                          address: Address

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.ComponentProtocol.html b/interfaces/interface.ComponentProtocol.html index e639b321..56dfe11e 100644 --- a/interfaces/interface.ComponentProtocol.html +++ b/interfaces/interface.ComponentProtocol.html @@ -1,2 +1,2 @@ -ComponentProtocol | welo

                                                                                                                                                                                          Interface ComponentProtocol<P>

                                                                                                                                                                                          interface ComponentProtocol<P> {
                                                                                                                                                                                              protocol: P;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • P extends string = string

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Properties

                                                                                                                                                                                          protocol: P

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +ComponentProtocol | welo

                                                                                                                                                                                          Interface ComponentProtocol<P>

                                                                                                                                                                                          interface ComponentProtocol<P> {
                                                                                                                                                                                              protocol: P;
                                                                                                                                                                                          }

                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                          • P extends string = string

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Properties

                                                                                                                                                                                          protocol: P

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.Components.html b/interfaces/interface.Components.html index 0b08b0bd..8c466e31 100644 --- a/interfaces/interface.Components.html +++ b/interfaces/interface.Components.html @@ -1,5 +1,5 @@ -Components | welo

                                                                                                                                                                                          Interface Components

                                                                                                                                                                                          interface Components {
                                                                                                                                                                                              access: AccessComponent<AccessInstance, string>[];
                                                                                                                                                                                              entry: EntryComponent<EntryInstance<unknown>, string>[];
                                                                                                                                                                                              identity: IdentityComponent<IdentityInstance<unknown>, string>[];
                                                                                                                                                                                              store: StoreComponent<StoreInstance, string>[];
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          access +Components | welo

                                                                                                                                                                                          Interface Components

                                                                                                                                                                                          interface Components {
                                                                                                                                                                                              access: AccessComponent<AccessInstance, string>[];
                                                                                                                                                                                              entry: EntryComponent<EntryInstance<unknown>, string>[];
                                                                                                                                                                                              identity: IdentityComponent<IdentityInstance<unknown>, string>[];
                                                                                                                                                                                              store: StoreComponent<StoreInstance, string>[];
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          access: AccessComponent<AccessInstance, string>[]
                                                                                                                                                                                          entry: EntryComponent<EntryInstance<unknown>, string>[]
                                                                                                                                                                                          identity: IdentityComponent<IdentityInstance<unknown>, string>[]
                                                                                                                                                                                          store: StoreComponent<StoreInstance, string>[]

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          access: AccessComponent<AccessInstance, string>[]
                                                                                                                                                                                          entry: EntryComponent<EntryInstance<unknown>, string>[]
                                                                                                                                                                                          identity: IdentityComponent<IdentityInstance<unknown>, string>[]
                                                                                                                                                                                          store: StoreComponent<StoreInstance, string>[]

                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.Config.html b/interfaces/interface.Config.html index b66c2df1..c8ebaae8 100644 --- a/interfaces/interface.Config.html +++ b/interfaces/interface.Config.html @@ -1,8 +1,8 @@ -Config | welo

                                                                                                                                                                                          Interface Config

                                                                                                                                                                                          interface Config {
                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                              components: Components;
                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                              identity: IdentityInstance<any>;
                                                                                                                                                                                              ipfs: GossipHelia<GossipLibp2p<GossipServiceMap>>;
                                                                                                                                                                                              keychain: Keychain;
                                                                                                                                                                                              replicators: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          blockstore +Config | welo

                                                                                                                                                                                          Interface Config

                                                                                                                                                                                          interface Config {
                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                              components: Components;
                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                              identity: IdentityInstance<any>;
                                                                                                                                                                                              ipfs: GossipHelia<GossipLibp2p<GossipServiceMap>>;
                                                                                                                                                                                              keychain: Keychain;
                                                                                                                                                                                              replicators: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                          }

                                                                                                                                                                                          Properties

                                                                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                          Type declaration

                                                                                                                                                                                            Type declaration

                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                          components: Components
                                                                                                                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                              identity: IdentityInstance<any>
                                                                                                                                                                                                                              keychain: Keychain
                                                                                                                                                                                                                              replicators: ReplicatorModule<Replicator, string>[]

                                                                                                                                                                                                                              Generated using TypeDoc

                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                              components: Components
                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                  identity: IdentityInstance<any>
                                                                                                                                                                                                                                                                  keychain: Keychain
                                                                                                                                                                                                                                                                  replicators: ReplicatorModule<Replicator, string>[]

                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface.DbComponents.html b/interfaces/interface.DbComponents.html index b26e1324..73c8ddbf 100644 --- a/interfaces/interface.DbComponents.html +++ b/interfaces/interface.DbComponents.html @@ -1,5 +1,5 @@ -DbComponents | welo

                                                                                                                                                                                                                                                                  Interface DbComponents

                                                                                                                                                                                                                                                                  interface DbComponents {
                                                                                                                                                                                                                                                                      access: AccessComponent<AccessInstance, string>;
                                                                                                                                                                                                                                                                      entry: EntryComponent<EntryInstance<unknown>, string>;
                                                                                                                                                                                                                                                                      identity: IdentityComponent<IdentityInstance<unknown>, string>;
                                                                                                                                                                                                                                                                      store: StoreComponent<StoreInstance, string>;
                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  access +DbComponents | welo

                                                                                                                                                                                                                                                                  Interface DbComponents

                                                                                                                                                                                                                                                                  interface DbComponents {
                                                                                                                                                                                                                                                                      access: AccessComponent<AccessInstance, string>;
                                                                                                                                                                                                                                                                      entry: EntryComponent<EntryInstance<unknown>, string>;
                                                                                                                                                                                                                                                                      identity: IdentityComponent<IdentityInstance<unknown>, string>;
                                                                                                                                                                                                                                                                      store: StoreComponent<StoreInstance, string>;
                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  entry: EntryComponent<EntryInstance<unknown>, string>
                                                                                                                                                                                                                                                                  identity: IdentityComponent<IdentityInstance<unknown>, string>

                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  entry: EntryComponent<EntryInstance<unknown>, string>
                                                                                                                                                                                                                                                                  identity: IdentityComponent<IdentityInstance<unknown>, string>

                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface.DbConfig.html b/interfaces/interface.DbConfig.html index 0d0414ac..f46a340f 100644 --- a/interfaces/interface.DbConfig.html +++ b/interfaces/interface.DbConfig.html @@ -1,4 +1,4 @@ -DbConfig | welo

                                                                                                                                                                                                                                                                  Interface DbConfig

                                                                                                                                                                                                                                                                  interface DbConfig {
                                                                                                                                                                                                                                                                      access: AccessInstance;
                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                      components: DbComponents;
                                                                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                      identity: IdentityInstance<any>;
                                                                                                                                                                                                                                                                      manifest: Manifest;
                                                                                                                                                                                                                                                                      provider?: Ed25519PeerId;
                                                                                                                                                                                                                                                                      replica: Replica;
                                                                                                                                                                                                                                                                      replicators: Replicator[];
                                                                                                                                                                                                                                                                      store: StoreInstance;
                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  • Omit<DbOpen, "start" | "ipfs" | "replicators">
                                                                                                                                                                                                                                                                    • DbConfig

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  access +DbConfig | welo

                                                                                                                                                                                                                                                                  Interface DbConfig

                                                                                                                                                                                                                                                                  interface DbConfig {
                                                                                                                                                                                                                                                                      access: AccessInstance;
                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                      components: DbComponents;
                                                                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                      identity: IdentityInstance<any>;
                                                                                                                                                                                                                                                                      manifest: Manifest;
                                                                                                                                                                                                                                                                      provider?: Ed25519PeerId;
                                                                                                                                                                                                                                                                      replica: Replica;
                                                                                                                                                                                                                                                                      replicators: Replicator[];
                                                                                                                                                                                                                                                                      store: StoreInstance;
                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                  Hierarchy

                                                                                                                                                                                                                                                                  • Omit<DbOpen, "start" | "ipfs" | "replicators">
                                                                                                                                                                                                                                                                    • DbConfig

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                  components: DbComponents
                                                                                                                                                                                                                                                                                  datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                      identity: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                      manifest: Manifest
                                                                                                                                                                                                                                                                                                      provider?: Ed25519PeerId
                                                                                                                                                                                                                                                                                                      replica: Replica
                                                                                                                                                                                                                                                                                                      replicators: Replicator[]

                                                                                                                                                                                                                                                                                                      Generated using TypeDoc

                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                      components: DbComponents
                                                                                                                                                                                                                                                                                                                      datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                          identity: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                          manifest: Manifest
                                                                                                                                                                                                                                                                                                                                          provider?: Ed25519PeerId
                                                                                                                                                                                                                                                                                                                                          replica: Replica
                                                                                                                                                                                                                                                                                                                                          replicators: Replicator[]

                                                                                                                                                                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.DbEvents.html b/interfaces/interface.DbEvents.html index 0a907717..33e75d1a 100644 --- a/interfaces/interface.DbEvents.html +++ b/interfaces/interface.DbEvents.html @@ -1,3 +1,3 @@ -DbEvents | welo

                                                                                                                                                                                                                                                                                                                                          Interface DbEvents

                                                                                                                                                                                                                                                                                                                                          interface DbEvents {
                                                                                                                                                                                                                                                                                                                                              closed: CustomEvent<ClosedEmit>;
                                                                                                                                                                                                                                                                                                                                              update: CustomEvent<undefined>;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          closed +DbEvents | welo

                                                                                                                                                                                                                                                                                                                                          Interface DbEvents

                                                                                                                                                                                                                                                                                                                                          interface DbEvents {
                                                                                                                                                                                                                                                                                                                                              closed: CustomEvent<ClosedEmit>;
                                                                                                                                                                                                                                                                                                                                              update: CustomEvent<undefined>;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          update: CustomEvent<undefined>

                                                                                                                                                                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          update: CustomEvent<undefined>

                                                                                                                                                                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.DbOpen.html b/interfaces/interface.DbOpen.html index 20f74b74..9460fb8d 100644 --- a/interfaces/interface.DbOpen.html +++ b/interfaces/interface.DbOpen.html @@ -1,4 +1,4 @@ -DbOpen | welo

                                                                                                                                                                                                                                                                                                                                          Interface DbOpen

                                                                                                                                                                                                                                                                                                                                          interface DbOpen {
                                                                                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                              components: DbComponents;
                                                                                                                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                              identity: IdentityInstance<any>;
                                                                                                                                                                                                                                                                                                                                              ipfs: GossipHelia<GossipLibp2p<GossipServiceMap>>;
                                                                                                                                                                                                                                                                                                                                              manifest: Manifest;
                                                                                                                                                                                                                                                                                                                                              provider?: Ed25519PeerId;
                                                                                                                                                                                                                                                                                                                                              replicators: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                                                                                                                                                                              start?: boolean;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          blockstore +DbOpen | welo

                                                                                                                                                                                                                                                                                                                                          Interface DbOpen

                                                                                                                                                                                                                                                                                                                                          interface DbOpen {
                                                                                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                              components: DbComponents;
                                                                                                                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                              identity: IdentityInstance<any>;
                                                                                                                                                                                                                                                                                                                                              ipfs: GossipHelia<GossipLibp2p<GossipServiceMap>>;
                                                                                                                                                                                                                                                                                                                                              manifest: Manifest;
                                                                                                                                                                                                                                                                                                                                              provider?: Ed25519PeerId;
                                                                                                                                                                                                                                                                                                                                              replicators: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                                                                                                                                                                              start?: boolean;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                          components: DbComponents
                                                                                                                                                                                                                                                                                                                                                          datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                              identity: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                                                              manifest: Manifest
                                                                                                                                                                                                                                                                                                                                                                              provider?: Ed25519PeerId
                                                                                                                                                                                                                                                                                                                                                                              replicators: ReplicatorModule<Replicator, string>[]
                                                                                                                                                                                                                                                                                                                                                                              start?: boolean

                                                                                                                                                                                                                                                                                                                                                                              Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              components: DbComponents
                                                                                                                                                                                                                                                                                                                                                                                              datastore: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                  identity: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                                                                                                  manifest: Manifest
                                                                                                                                                                                                                                                                                                                                                                                                                  provider?: Ed25519PeerId
                                                                                                                                                                                                                                                                                                                                                                                                                  replicators: ReplicatorModule<Replicator, string>[]
                                                                                                                                                                                                                                                                                                                                                                                                                  start?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface.Determine.html b/interfaces/interface.Determine.html index 7c8b259d..4c331df4 100644 --- a/interfaces/interface.Determine.html +++ b/interfaces/interface.Determine.html @@ -1,4 +1,4 @@ -Determine | welo

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Determine

                                                                                                                                                                                                                                                                                                                                                                                                                  interface Determine {
                                                                                                                                                                                                                                                                                                                                                                                                                      access?: AccessProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      entry?: EntryProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      identity?: IdentityProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      meta?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      store?: StoreProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  access? +Determine | welo

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Determine

                                                                                                                                                                                                                                                                                                                                                                                                                  interface Determine {
                                                                                                                                                                                                                                                                                                                                                                                                                      access?: AccessProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      entry?: EntryProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      identity?: IdentityProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      meta?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      protocol?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      store?: StoreProtocol;
                                                                                                                                                                                                                                                                                                                                                                                                                      tag?: Uint8Array;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  identity?: IdentityProtocol
                                                                                                                                                                                                                                                                                                                                                                                                                  meta?: any
                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                  protocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  identity?: IdentityProtocol
                                                                                                                                                                                                                                                                                                                                                                                                                  meta?: any
                                                                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                                                                  protocol?: string

                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface.Events.html b/interfaces/interface.Events.html index e0a4c107..855c7ff1 100644 --- a/interfaces/interface.Events.html +++ b/interfaces/interface.Events.html @@ -1,3 +1,3 @@ -Events | welo

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Events

                                                                                                                                                                                                                                                                                                                                                                                                                  interface Events {
                                                                                                                                                                                                                                                                                                                                                                                                                      closed: CustomEvent<ClosedEmit>;
                                                                                                                                                                                                                                                                                                                                                                                                                      opened: CustomEvent<OpenedEmit>;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  closed +Events | welo

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface Events

                                                                                                                                                                                                                                                                                                                                                                                                                  interface Events {
                                                                                                                                                                                                                                                                                                                                                                                                                      closed: CustomEvent<ClosedEmit>;
                                                                                                                                                                                                                                                                                                                                                                                                                      opened: CustomEvent<OpenedEmit>;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/interfaces/interface.OpenOptions.html b/interfaces/interface.OpenOptions.html index f9e4fb77..41a44ffc 100644 --- a/interfaces/interface.OpenOptions.html +++ b/interfaces/interface.OpenOptions.html @@ -1,5 +1,5 @@ -OpenOptions | welo

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface OpenOptions

                                                                                                                                                                                                                                                                                                                                                                                                                  interface OpenOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                      datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                      identity?: IdentityInstance<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                      provider?: Ed25519PeerId;
                                                                                                                                                                                                                                                                                                                                                                                                                      replicators?: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  datastore? +OpenOptions | welo

                                                                                                                                                                                                                                                                                                                                                                                                                  Interface OpenOptions

                                                                                                                                                                                                                                                                                                                                                                                                                  interface OpenOptions {
                                                                                                                                                                                                                                                                                                                                                                                                                      datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                      identity?: IdentityInstance<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                      provider?: Ed25519PeerId;
                                                                                                                                                                                                                                                                                                                                                                                                                      replicators?: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                  datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                      identity?: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                                                                                                                      provider?: Ed25519PeerId
                                                                                                                                                                                                                                                                                                                                                                                                                                      replicators?: ReplicatorModule<Replicator, string>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                      Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                          identity?: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                          provider?: Ed25519PeerId
                                                                                                                                                                                                                                                                                                                                                                                                                                                          replicators?: ReplicatorModule<Replicator, string>[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.OpenedEmit.html b/interfaces/interface.OpenedEmit.html index 4a5b3e62..665b9bea 100644 --- a/interfaces/interface.OpenedEmit.html +++ b/interfaces/interface.OpenedEmit.html @@ -1,2 +1,2 @@ -OpenedEmit | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface OpenedEmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface OpenedEmit {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              address: Address;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          address: Address

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +OpenedEmit | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface OpenedEmit

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface OpenedEmit {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              address: Address;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Hierarchy

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          address: Address

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/interfaces/interface.WeloInit.html b/interfaces/interface.WeloInit.html index 825d2dd5..7b2ce98d 100644 --- a/interfaces/interface.WeloInit.html +++ b/interfaces/interface.WeloInit.html @@ -1,7 +1,7 @@ -WeloInit | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface WeloInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WeloInit {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              components?: Components;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              identity?: IdentityInstance<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              ipfs: GossipHelia<GossipLibp2p<GossipServiceMap>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              replicators?: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                              start?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          components? +WeloInit | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Interface WeloInit

                                                                                                                                                                                                                                                                                                                                                                                                                                                          interface WeloInit {
                                                                                                                                                                                                                                                                                                                                                                                                                                                              components?: Components;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              identity?: IdentityInstance<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              ipfs: GossipHelia<GossipLibp2p<GossipServiceMap>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                              replicators?: ReplicatorModule<Replicator, string>[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                              start?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                          components?: Components
                                                                                                                                                                                                                                                                                                                                                                                                                                                          datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identity?: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              replicators?: ReplicatorModule<Replicator, string>[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              start?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              components?: Components
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              datastore?: Datastore<{}, {}, {}, {}, {}, {}, {}, {}, {}, {}>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identity?: IdentityInstance<any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  replicators?: ReplicatorModule<Replicator, string>[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  start?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/modules/database.html b/modules/database.html index 97eadebe..7e93e69e 100644 --- a/modules/database.html +++ b/modules/database.html @@ -1,2 +1,2 @@ -database | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Database +database | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module database

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/modules/index-1.html b/modules/index-1.html index 0c4fb68e..126ddc5c 100644 --- a/modules/index-1.html +++ b/modules/index-1.html @@ -1,5 +1,5 @@ index | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  peer-to-peer, collaborative states using merkle-crdts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Address Config Create Database diff --git a/modules/index.html b/modules/index.html index b8600873..33a683c0 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,5 +1,5 @@ index | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  peer-to-peer, collaborative states using merkle-crdts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Config Create Database Determine diff --git a/modules/interface.html b/modules/interface.html index 759bb3cf..dc49754e 100644 --- a/modules/interface.html +++ b/modules/interface.html @@ -1,4 +1,4 @@ -interface | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ClosedEmit +interface | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module interface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ClosedEmit ComponentProtocol Components Config diff --git a/modules/welo.html b/modules/welo.html index 2a82cef0..7ef545ec 100644 --- a/modules/welo.html +++ b/modules/welo.html @@ -1,4 +1,4 @@ -welo | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Address +welo | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Module welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  References

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Address Config Create Database diff --git a/types/interface.GossipHelia.html b/types/interface.GossipHelia.html index 27c71f8e..03fc0ce9 100644 --- a/types/interface.GossipHelia.html +++ b/types/interface.GossipHelia.html @@ -1 +1 @@ -GossipHelia | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type alias GossipHelia<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GossipHelia<T>: Helia<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +GossipHelia | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type alias GossipHelia<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GossipHelia<T>: Helia<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/types/interface.GossipLibp2p.html b/types/interface.GossipLibp2p.html index efd96a2c..b95cc76b 100644 --- a/types/interface.GossipLibp2p.html +++ b/types/interface.GossipLibp2p.html @@ -1 +1 @@ -GossipLibp2p | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type alias GossipLibp2p<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GossipLibp2p<T>: Libp2p<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +GossipLibp2p | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type alias GossipLibp2p<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GossipLibp2p<T>: Libp2p<T>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/types/interface.GossipServiceMap.html b/types/interface.GossipServiceMap.html index 52386d7b..bed461bc 100644 --- a/types/interface.GossipServiceMap.html +++ b/types/interface.GossipServiceMap.html @@ -1 +1 @@ -GossipServiceMap | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type alias GossipServiceMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GossipServiceMap: ServiceMap & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keychain: Keychain;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pubsub: PubSub;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +GossipServiceMap | welo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type alias GossipServiceMap

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  GossipServiceMap: ServiceMap & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keychain: Keychain;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pubsub: PubSub;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Generated using TypeDoc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file