Class Objectarium

OKP4 object store.

Hierarchy (view full)

Constructors

constructor

Properties

connection? instance? log v2.0.0

Methods

execute forget pin query store unpin init

Constructors

constructor

Properties

Optional connection

connection?: Chain.Connection

Optional instance

instance?: {
    address?: string;
}

Type declaration

  • Optional address?: string

log

log: Core.Console

Static v2.0.0

v2.0.0: typeof Objectarium_v2_1_0 = ...

Methods

execute

  • execute(message, options?): Promise<unknown>

  • Execute a transaction on the specified instance as the specified Connection.

    Parameters

    • message: Message
    • options: {
          execFee?: IFee;
          execMemo?: string;
          execSend?: ICoin[];
      } = {}
      • Optional execFee?: IFee
      • Optional execMemo?: string
      • Optional execSend?: ICoin[]

    Returns Promise<unknown>

forget

pin

query

  • query<Q>(message): Promise<Q>

  • Execute a query on the specified instance as the specified Connection.

    Type Parameters

    • Q

    Parameters

    Returns Promise<Q>

store

unpin

Static init

  • init(bucket): {
        bucket: string;
    }

  • Create an init message for an objectarium.

    Parameters

    • bucket: string

    Returns {
        bucket: string;
    }

    • bucket: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc