Skip to content

endpoint ¤

Modules:

  • create –

    Protocols for creating new entities in the Fluree ledger.

  • history –

    Protocols and types for querying historical data in the Fluree ledger.

  • query –

    Protocols and types for building and executing queries in the Fluree ledger.

  • transaction –

    Protocols for building and executing transactions in the Fluree ledger.

Classes:

CreateBuilder ¤

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

Protocol for building create operations.

CreateReadyToCommit ¤

Bases: SupportsRequestCreation, SupportsCommitable, HasInsertData, HasContextData, Protocol

Protocol for create operations ready to be committed.

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.

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.

TransactionBuilder ¤

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

Protocol for building transaction operations.

TransactionReadyToCommit ¤

Bases: SupportsRequestCreation, SupportsCommitable, SupportsContext['TransactionReadyToCommit'], SupportsWhere['TransactionReadyToCommit'], HasInsertData, Protocol

Protocol for transaction operations ready to be committed.

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.