Interface UseExecuteQueryParams<T>

Parameters for useExecuteQuery.

interface UseExecuteQueryParams<T> {
    onError?: ((error) => void);
    persistenceDirectory?: string;
    queryArguments?: T;
}

Type Parameters

  • T extends DQLQueryArguments = DQLQueryArguments

    The type of query arguments.

Properties

onError? persistenceDirectory? queryArguments?

Properties

Optional onError

onError?: ((error) => void)

A callback to run when an error occurs.

Type declaration

    • (error): void

    • Parameters

      • error: unknown

        The error that occurred during query execution.

      Returns void

Optional persistenceDirectory

persistenceDirectory?: string

Identifies the Ditto instance to use when multiple instances are registered in the DittoProvider. Defaults to the first registered instance.

See Ditto.absolutePersistenceDirectory.

Optional queryArguments

queryArguments?: T

The arguments to pass to the query.

Settings

Member Visibility

Theme

On This Page

onErrorpersistenceDirectoryqueryArguments