From c8b814049a4762db6a201ab0fecbbd4f808c31b5 Mon Sep 17 00:00:00 2001 From: Meno Abels Date: Tue, 10 Dec 2024 17:09:40 -0500 Subject: [PATCH] build from 03b70cff721d9c45d2b9aedeba626b4ed9b77e01 [skip ci] --- docs/classes/Database.html | 15 +++++++++------ docs/functions/fireproof.html | 2 +- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/classes/Database.html b/docs/classes/Database.html index 0e5386b9..3c952d7c 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

constructor

Properties

_crdt _listeners _listening @@ -25,13 +25,16 @@ query ready subscribe -

Constructors

constructor

  • new Database<DT extends {} = {}>(name?: string, opts?: ConfigOpts): Database<DT>

  • Type Parameters

    • DT extends {} = {}

    Parameters

    • Optionalname: string
    • Optionalopts: ConfigOpts

    Returns Database<DT>

Properties

Readonly_crdt

_crdt: CRDT<DT>

Readonly_listeners

_listeners: Set<ListenerFn<DT>> = ...

_listening

_listening: boolean = false

Readonly_noupdate_listeners

_noupdate_listeners: Set<ListenerFn<DT>> = ...

Readonly_ready

_ready: ResolveOnce<void, void> = ...

Readonly_writeQueue

_writeQueue: WriteQueue<DT>

Readonlyblockstore

blockstore: BaseBlockstore

Readonlylogger

logger: Logger

Optional Readonlyname

name?: string

Readonlyopts

opts: ConfigOpts = {}

Readonlysthis

sthis: SuperThis

Staticdatabases

databases: Map<string, Database<{}>> = ...

Methods

_no_update_notify

  • _no_update_notify(): Promise<void>

  • Returns Promise<void>

_notify

  • _notify(updates: DocUpdate<{}>[]): Promise<void>

  • Parameters

    • updates: DocUpdate<{}>[]

    Returns Promise<void>

allDocs

  • allDocs<T extends {}>(opts?: AllDocsQueryOpts): Promise<AllDocsResponse<T>>

  • Type Parameters

    • T extends {}

    Parameters

    • opts: AllDocsQueryOpts = {}

    Returns Promise<AllDocsResponse<T>>

allDocuments

  • allDocuments<T extends {}>(): Promise<
        { clock: ClockHead; rows: { key: string; value: DocWithId<T> }[] },
    >

  • Type Parameters

    • T extends {}

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

changes

  • changes<T extends {}>(
        since?: ClockHead,
        opts?: ChangesOptions,
    ): Promise<ChangesResponse<T>>

  • Type Parameters

    • T extends {}

    Parameters

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

    Returns Promise<ChangesResponse<T>>

close

  • close(): Promise<void>

  • Close the database and release resources

    -

    Returns Promise<void>

compact

del

  • del(id: string): Promise<DocResponse>

  • Parameters

    • id: string

    Returns Promise<DocResponse>

destroy

  • destroy(): Promise<void>

  • Destroy the database and release all resources

    -

    Returns Promise<void>

get

  • get<T extends {}>(id: string): Promise<DocWithId<T>>

  • Get a document from the database

    +

Constructors

constructor

  • new Database<DT extends {} = {}>(name?: string, opts?: ConfigOpts): Database<DT>

  • Type Parameters

    • DT extends {} = {}

    Parameters

    • Optionalname: string
    • Optionalopts: ConfigOpts

    Returns Database<DT>

Properties

Readonly_crdt

_crdt: CRDT<DT>

Readonly_listeners

_listeners: Set<ListenerFn<DT>> = ...

_listening

_listening: boolean = false

Readonly_noupdate_listeners

_noupdate_listeners: Set<ListenerFn<DT>> = ...

Readonly_ready

_ready: ResolveOnce<void, void> = ...

Readonly_writeQueue

_writeQueue: WriteQueue<DT>

Readonlyblockstore

blockstore: BaseBlockstore

Readonlylogger

logger: Logger

Optional Readonlyname

name?: string

Readonlyopts

opts: ConfigOpts = {}

Readonlysthis

sthis: SuperThis

Staticdatabases

databases: Map<string, Database<{}>> = ...

Methods

_no_update_notify

  • _no_update_notify(): Promise<void>

  • Returns Promise<void>

_notify

  • _notify(updates: DocUpdate<{}>[]): Promise<void>

  • Parameters

    • updates: DocUpdate<{}>[]

    Returns Promise<void>

allDocs

  • allDocs<T extends {}>(opts?: AllDocsQueryOpts): Promise<AllDocsResponse<T>>

  • Type Parameters

    • T extends {}

    Parameters

    • opts: AllDocsQueryOpts = {}

    Returns Promise<AllDocsResponse<T>>

allDocuments

  • allDocuments<T extends {}>(): Promise<
        { clock: ClockHead; rows: { key: string; value: DocWithId<T> }[] },
    >

  • Type Parameters

    • T extends {}

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

changes

  • changes<T extends {}>(
        since?: ClockHead,
        opts?: ChangesOptions,
    ): Promise<ChangesResponse<T>>

  • Type Parameters

    • T extends {}

    Parameters

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

    Returns Promise<ChangesResponse<T>>

close

  • close(): Promise<void>

  • Close the database and release resources

    +

    Returns Promise<void>

compact

del

  • del(id: string): Promise<DocResponse>

  • delete a document from the database

    +

    Parameters

    • id: string

      Document id

      +

    Returns Promise<DocResponse>

    DocResponse with the id and clock

    +

destroy

  • destroy(): Promise<void>

  • Destroy the database and release all resources

    +

    Returns Promise<void>

get

  • get<T extends {}>(id: string): Promise<DocWithId<T>>

  • 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

    Throws

    NotFoundError if the document is not found

    -

put

  • put<T extends {}>(doc: DocSet<T>): Promise<DocResponse>

  • Put a document from the database

    +

put

  • put<T extends {}>(doc: DocSet<T>): Promise<DocResponse>

  • Put a document from the database

    Type Parameters

    • T extends {}

    Parameters

    • doc: DocSet<T>

      the document to put

    Returns Promise<DocResponse>

    add DocResponse with the id and clock

    -

query

  • query<K extends IndexKeyType, T extends {}, R extends DocFragment = T>(
        field: string | MapFn<T>,
        opts?: QueryOpts<K>,
    ): Promise<IndexRows<K, T, R>>

  • 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>>

ready

subscribe

  • subscribe<T extends {}>(listener: ListenerFn<T>, updates?: boolean): () => void

  • Type Parameters

    • T extends {}

    Parameters

    • listener: ListenerFn<T>
    • Optionalupdates: boolean

    Returns () => void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

query

ready

subscribe

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/functions/fireproof.html b/docs/functions/fireproof.html index 5f4aa683..06d28c5c 100644 --- a/docs/functions/fireproof.html +++ b/docs/functions/fireproof.html @@ -1 +1 @@ -fireproof | @fireproof/monorepo

Function fireproof

Settings

Member Visibility
+fireproof | @fireproof/monorepo

Function fireproof

Settings

Member Visibility