prorm API Reference
    Preparing search index...

    Interface BigchaindbStoreOptions

    Connection options for BigchaindbStore.

    interface BigchaindbStoreOptions {
        url?: string;
        headers?: Record<string, string>;
        keypair?: BigchaindbKeypair;
        client?: BigchaindbConnectionLike;
        transaction?: BigchaindbTransactionFactory;
    }
    Index
    url? headers? keypair? client? transaction?
    url?: string

    BigchainDB API root, e.g. 'http://localhost:9984/api/v1/'.

    headers?: Record<string, string>

    Extra headers (e.g. an app_id/app_key for hosted BigchainDB).

    keypair?: BigchaindbKeypair

    Keypair used to sign CREATE transactions in append. Required to write.

    client?: BigchaindbConnectionLike

    A pre-built Connection to use instead of the lazy require.

    transaction?: BigchaindbTransactionFactory

    A pre-built Transaction factory (injected in tests alongside client).

    Settings
    Member Visibility

    On This Page
    Properties