protocol

HTTP protocol module for Fluree operations.

This module provides the core protocol definitions and builders for interacting
with Fluree through HTTP.

Modules:

• endpoint –
• ledger –
• mixin –

  Protocol mixin modules for Fluree ledger operations.

Classes:

• CreateBuilder –

  Protocol for building create operations.

• HistoryBuilder –

  Protocol for history builders.

• QueryBuilder –

  Protocol for building query operations.

• SupportsLedgerOperations –

  Protocol defining core ledger operations.

• TransactionBuilder –

  Protocol for building transaction operations.

CreateBuilder

Bases: SupportsContext['CreateBuilder'], SupportsInsert['CreateReadyToCommit'], Protocol

Protocol for building create operations.

HistoryBuilder

Bases: SupportsContext['HistoryBuilder'], SupportsRequestCreation, SupportsCommitable, Protocol

Protocol for history builders.

Methods:

• acommit –

  Executes the transaction asynchronously.

• commit –

  Executes the transaction synchronously.

acommit async

acommit() -> FlureeResponse

Executes the transaction asynchronously.

Raises:

• RequestError –

  If the HTTP request fails.

• TypeError –

  If the type parameter cannot be resolved.

commit

commit() -> FlureeResponse

Executes the transaction synchronously.

Raises:

• RequestError –

  If the HTTP request fails.

• TypeError –

  If the type parameter cannot be resolved.

QueryBuilder

Bases: SupportsContext['QueryBuilder'], SupportsWhere['QueryBuilder'], SupportsRequestCreation, SupportsCommitable, Protocol

Protocol for building query operations.

Methods:

• acommit –

  Executes the transaction asynchronously.

• commit –

  Executes the transaction synchronously.

acommit async

acommit() -> FlureeResponse

Executes the transaction asynchronously.

Raises:

• RequestError –

  If the HTTP request fails.

• TypeError –

  If the type parameter cannot be resolved.

commit

commit() -> FlureeResponse

Executes the transaction synchronously.

Raises:

• RequestError –

  If the HTTP request fails.

• TypeError –

  If the type parameter cannot be resolved.

SupportsLedgerOperations

Bases: Protocol

Protocol defining core ledger operations.

TransactionBuilder

Bases: SupportsContext['TransactionBuilder'], SupportsInsert['TransactionReadyToCommit'], SupportsWhere['TransactionBuilder'], Protocol

Protocol for building transaction operations.