Interface ValidateQueryOptions

interface ValidateQueryOptions {
    containerPath?: string;
    failure?: RequestFailure<any>;
    scope?: any;
    success?: RequestSuccess<{
        valid: boolean;
    }>;
    validateQueryMetadata?: boolean;
}

Hierarchy (view full)

Properties

containerPath? failure? scope? success? validateQueryMetadata?

Properties

Optional containerPath

containerPath?: string

A container path in which to execute this command. If not supplied, the current container will be used.

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional scope

scope?: any

A scoping object for the success and failure callback functions (default to this).

Optional success

success?: RequestSuccess<{
    valid: boolean;
}>

This will be called upon successfully completing a request.

Type declaration

  • valid: boolean

Optional validateQueryMetadata

validateQueryMetadata?: boolean

If true, the query metadata and custom views will also be validated.

Settings

Member Visibility

Theme

On This Page

containerPathfailurescopesuccessvalidateQueryMetadata

Generated using TypeDoc