Class FlureeStore

constructor

• new FlureeStore(options: FlureeStoreOptions): FlureeStore

  Parameters

  • options: FlureeStoreOptions

  Returns FlureeStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): FlureeHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns FlureeHttpClient

append

• append(collection: string, data: Record<string, unknown>): Promise<unknown>

  Append data to collection as a transaction (POST .../transact). Returns the transaction response (block, flakes, temp-id map, and the block hash that anchors the write into the immutable log).

  Parameters

  • collection: string
  • data: Record<string, unknown>

  Returns Promise<unknown>

get

• get(collection: string, id: string | number): Promise<unknown>

  Read subject id from collection (POST .../query).

  Parameters

  • collection: string
  • id: string | number

  Returns Promise<unknown>

history

• history(collection: string, id: string | number): Promise<unknown>

  Return the flake-level history of subject id (POST .../history).

  Parameters

  • collection: string
  • id: string | number

  Returns Promise<unknown>

verify

• verify(collection: string, id: string | number): Promise<unknown>

  Return the provenance/proof for subject id: its history with block metadata (meta: true), so callers see the block hash and instant that cryptographically anchor each revision into Fluree's tamper-evident log.

  Parameters

  • collection: string
  • id: string | number

  Returns Promise<unknown>

query

• query(flureeql: unknown): Promise<unknown>

  Run a raw FlureeQL query object (POST .../query).

  Parameters

  • flureeql: unknown

  Returns Promise<unknown>

transact

• transact(transaction: unknown): Promise<unknown>

  Run a raw FlureeQL transaction (POST .../transact).

  Parameters

  • transaction: unknown

  Returns Promise<unknown>