ao-js-sdk - v0.4.0
    Preparing search index...

    Interface IHyperbeamClient

    Interface for HyperBEAM client that provides access to AO-Core process state

    interface IHyperbeamClient {
        compute(processId: string, additionalPath?: string): Promise<any>;
        getProcessState(
            processId: string,
            endpoint: ProcessEndpoint,
            additionalPath?: string,
        ): Promise<any>;
    }

    Implemented by

    Index

    Methods

    compute getProcessState

    Methods

    • Retrieves the cached state of a specific process from the HyperBEAM node (compute endpoint)

      This is a convenience method that uses the compute endpoint for faster, cached responses.

      Parameters

      • processId: string

        The process ID to query

      • OptionaladditionalPath: string

        Optional additional path components to access specific data within the process state

      Returns Promise<any>

      Promise resolving to the process state data

      // Get cached process state (fastest)
      const state = await client.compute('process-id');

      // Get specific data from cached process state
      const balances = await client.compute('process-id', 'balances/wallet-address');

    • Retrieves the state of a specific process from the HyperBEAM node using a specified endpoint

      Parameters

      • processId: string

        The process ID to query

      • endpoint: ProcessEndpoint

        The process endpoint to use (compute or now)

      • OptionaladditionalPath: string

        Optional additional path components to access specific data within the process state

      Returns Promise<any>

      Promise resolving to the process state data

      // Get cached process state with specific path
      const state = await client.getProcessState('process-id', ProcessEndpoint.COMPUTE, 'balances/wallet-address');

      // Get real-time process state
      const freshState = await client.getProcessState('process-id', ProcessEndpoint.NOW);

    Settings

    Member Visibility

    On This Page

    Methods