diff --git a/docs/classes/Database.html b/docs/classes/Database.html index 82e5f18a..367be653 100644 --- a/docs/classes/Database.html +++ b/docs/classes/Database.html @@ -1,4 +1,4 @@ -Database | @fireproof/monorepo

Class Database<DT>

Type Parameters

  • DT extends DocTypes = NonNullable<unknown>

Implements

  • Connectable

Constructors

constructor +Database | @fireproof/monorepo

Class Database<DT>

Type Parameters

  • DT extends DocTypes = NonNullable<unknown>

Implements

  • Connectable

Constructors

Properties

Constructors

  • Type Parameters

    • DT extends {} = {}

    Parameters

    • Optionalname: string
    • Optionalopts: ConfigOpts

    Returns Database<DT>

Properties

_crdt: CRDT<DT>
_listeners: Set<ListenerFn<DT>> = ...
_listening: boolean = false
_noupdate_listeners: Set<ListenerFn<DT>> = ...
_ready: ResolveOnce<void, void> = ...
_writeQueue: WriteQueue<DT>
blockstore: BaseBlockstore
logger: Logger
name?: string
opts: ConfigOpts = {}
sthis: SuperThis
databases: Map<string, Database<{}>> = ...

Methods

  • Returns Promise<void>

  • Parameters

    • updates: DocUpdate<{}>[]

    Returns Promise<void>

  • Type Parameters

    • T extends {}

    Parameters

    • opts: AllDocsQueryOpts = {}

    Returns Promise<AllDocsResponse<T>>

  • Type Parameters

    • T extends {}

    Returns Promise<{ clock: ClockHead; rows: { key: string; value: DocWithId<T> }[] }>

  • Type Parameters

    • T extends {}

    Parameters

    • since: ClockHead = []
    • opts: ChangesOptions = {}

    Returns Promise<ChangesResponse<T>>

  • Parameters

    • id: string

    Returns Promise<DocResponse>

  • Returns Promise<void>

  • Type Parameters

    • T extends {}

    Parameters

    • id: string

    Returns Promise<DocWithId<T>>

  • Type Parameters

    • T extends {}

    Parameters

    • doc: DocSet<T>

    Returns Promise<DocResponse>

  • Type Parameters

    • K extends IndexKeyType
    • T extends {}
    • R extends DocFragment = T

    Parameters

    • field: string | MapFn<T>
    • opts: QueryOpts<K> = {}

    Returns Promise<IndexRows<K, T, R>>

  • Type Parameters

    • T extends {}

    Parameters

    • listener: ListenerFn<T>
    • Optionalupdates: boolean

    Returns () => void

+

Constructors

  • Type Parameters

    • DT extends {} = {}

    Parameters

    • Optionalname: string
    • Optionalopts: ConfigOpts

    Returns Database<DT>

Properties

_crdt: CRDT<DT>
_listeners: Set<ListenerFn<DT>> = ...
_listening: boolean = false
_noupdate_listeners: Set<ListenerFn<DT>> = ...
_ready: ResolveOnce<void, void> = ...
_writeQueue: WriteQueue<DT>
blockstore: BaseBlockstore
logger: Logger
name?: string
opts: ConfigOpts = {}
sthis: SuperThis
databases: Map<string, Database<{}>> = ...

Methods

  • Returns Promise<void>

  • Parameters

    • updates: DocUpdate<{}>[]

    Returns Promise<void>

  • Type Parameters

    • T extends {}

    Parameters

    • opts: AllDocsQueryOpts = {}

    Returns Promise<AllDocsResponse<T>>

  • Type Parameters

    • T extends {}

    Returns Promise<{ clock: ClockHead; rows: { key: string; value: DocWithId<T> }[] }>

  • Type Parameters

    • T extends {}

    Parameters

    • since: ClockHead = []
    • opts: ChangesOptions = {}

    Returns Promise<ChangesResponse<T>>

  • Close the database and release resources

    +

    Returns Promise<void>

  • Parameters

    • id: string

    Returns Promise<DocResponse>

  • Destroy the database and release all resources

    +

    Returns Promise<void>

  • Get a document from the database

    +

    Type Parameters

    • T extends {}

    Parameters

    • id: string

      the document id

      +

    Returns Promise<DocWithId<T>>

    the document with the _id

    +

    NotFoundError if the document is not found

    +
  • Type Parameters

    • T extends {}

    Parameters

    • doc: DocSet<T>

    Returns Promise<DocResponse>

  • Type Parameters

    • K extends IndexKeyType
    • T extends {}
    • R extends DocFragment = T

    Parameters

    • field: string | MapFn<T>
    • opts: QueryOpts<K> = {}

    Returns Promise<IndexRows<K, T, R>>

  • Type Parameters

    • T extends {}

    Parameters

    • listener: ListenerFn<T>
    • Optionalupdates: boolean

    Returns () => void

diff --git a/docs/functions/fireproof.html b/docs/functions/fireproof.html index 7489556c..e06c496c 100644 --- a/docs/functions/fireproof.html +++ b/docs/functions/fireproof.html @@ -1 +1 @@ -fireproof | @fireproof/monorepo
+fireproof | @fireproof/monorepo
diff --git a/docs/index.html b/docs/index.html index 51de3c31..fde4a149 100644 --- a/docs/index.html +++ b/docs/index.html @@ -81,8 +81,12 @@
deno run --config node_modules/@fireproof/core/deno.json --allow-read --allow-write --allow-env --unstable-sloppy-imports ./node-test.ts
 
+

Caution it will be pushed directly

+
pnpm run build:doc
+
+

Fireproof is a synthesis of work done by people in the web community over the years. I couldn't even begin to name all the folks who made pivotal contributions. Without npm, React, and VS Code all this would have taken so much longer. Thanks to everyone who supported me getting into database development via Apache CouchDB, one of the original document databases. The distinguishing work on immutable data-structures comes from the years of consideration IPFS, IPLD, and the Filecoin APIs have enjoyed.

Thanks to Alan Shaw and Mikeal Rogers without whom this project would have never got started. The core Merkle hash-tree clock is based on Alan's Pail, and you can see the repository history goes all the way back to work begun as a branch of that repo. Mikeal wrote the prolly trees implementation.

We love contributions. Feel free to join in the conversation on Discord. All welcome.

License

Dual-licensed under MIT or Apache 2.0

-
+