Function useQuery

  • useQuery<T extends object, K, I extends string>(
        template: TemplateOrInterface<T, K, I>,
        queryFactory: () => Query<T>,
        queryDeps: readonly unknown[],
    ): QueryResult<T, K, I>

    React Hook for a query against the ledger.

    Type Parameters

    • T extends object
    • K
    • I extends string

    Parameters

    • template: TemplateOrInterface<T, K, I>

      The contract template or interface to filter for.

    • queryFactory: () => Query<T>

      A function returning a query. If the query is omitted, all visible contracts of the given template are returned.

    • queryDeps: readonly unknown[]

      The dependencies of the query (which trigger a reload when changed).

    Returns QueryResult<T, K, I>

    The result of the query.

    Typeparam

    T The contract template or interface type of the query.

    Typeparam

    K The contract key type of the query.

    Typeparam

    I The template id type.

  • useQuery<T extends object, K, I extends string>(
        template: TemplateOrInterface<T, K, I>,
    ): QueryResult<T, K, I>

    React Hook for a query against the ledger.

    Type Parameters

    • T extends object
    • K
    • I extends string

    Parameters

    • template: TemplateOrInterface<T, K, I>

      The contract template or interface to filter for.

    Returns QueryResult<T, K, I>

    The result of the query.

    Typeparam

    T The contract template or interface type of the query.

    Typeparam

    K The contract key type of the query.

    Typeparam

    I The template id type.

Settings

Member Visibility