Skip to main content

Interface: QueryListResponse<DataType, ItemType, ErrorType>

Defined in: lib/k8s/api/v2/hooks.ts:74

Query response containing KubeList with added items field for convenience

Extends​

Type Parameters​

Type Parameter
DataType
ItemType
ErrorType

Properties​

clusterResults?​

optional clusterResults?: Record<string, QueryListResponse<DataType, ItemType, ErrorType>>;

Defined in: lib/k8s/api/v2/hooks.ts:80

Results from individual clusters. Keyed by cluster name.

data​

data: DataType | null;

Defined in: lib/k8s/api/v2/hooks.ts:37

The last successfully resolved data for the query.

Inherited from​

QueryResponse.data

error​

error: ErrorType | null;

Defined in: lib/k8s/api/v2/hooks.ts:42

The error object for the query, if an error was thrown.

  • Defaults to null.

Inherited from​

QueryResponse.error

errors​

errors: ApiError[] | null;

Defined in: lib/k8s/api/v2/hooks.ts:81

isError​

isError: boolean;

Defined in: lib/k8s/api/v2/hooks.ts:47

A derived boolean from the status variable, provided for convenience.

  • true if the query attempt resulted in an error.

Inherited from​

QueryResponse.isError

isFetching​

isFetching: boolean;

Defined in: lib/k8s/api/v2/hooks.ts:55

Is true whenever the query is executing, which includes initial fetch as well as background refetch.

Inherited from​

QueryResponse.isFetching

isLoading​

isLoading: boolean;

Defined in: lib/k8s/api/v2/hooks.ts:51

Is true whenever the first fetch for a query is in-flight.

Inherited from​

QueryResponse.isLoading

isSuccess​

isSuccess: boolean;

Defined in: lib/k8s/api/v2/hooks.ts:60

A derived boolean from the status variable, provided for convenience.

  • true if the query has received a response with no errors and is ready to display its data.

Inherited from​

QueryResponse.isSuccess

items​

items: ItemType[] | null;

Defined in: lib/k8s/api/v2/hooks.ts:76

status​

status: QueryStatus;

Defined in: lib/k8s/api/v2/hooks.ts:68

The status of the query.

  • Will be:
    • pending if there's no cached data and no query attempt was finished yet.
    • error if the query attempt resulted in an error.
    • success if the query has received a response with no errors and is ready to display its data.

Inherited from​

QueryResponse.status