Skip to main content

Function: useKubeObject()

function useKubeObject<K>(__namedParameters: object): [K | null, ApiError | null] & QueryResponse<K, ApiError>;

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

Returns a single KubeObject.

Type Parameters​

Type Parameter
K extends KubeObject<any>

Parameters​

ParameterTypeDescription
__namedParameters{ cluster?: string; initialData?: K; kubeObjectClass: (...args: any) => K & typeof KubeObject; name: string; namespace?: string; queryParams?: QueryParameters; }-
__namedParameters.cluster?stringCluster name
__namedParameters.initialData?KSeed data to use before the query resolves. Must be reference-stable across renders (memoize it or capture it once) — an object rebuilt on every render will cause repeated re-renders.
__namedParameters.kubeObjectClass(...args: any) => K & typeof KubeObjectClass to instantiate the object with
__namedParameters.namestringObject name
__namedParameters.namespace?stringObject namespace
__namedParameters.queryParams?QueryParameters-

Returns​

[K | null, ApiError | null] & QueryResponse<K, ApiError>