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
| Parameter | Type | Description |
|---|---|---|
__namedParameters | { cluster?: string; initialData?: K; kubeObjectClass: (...args: any) => K & typeof KubeObject; name: string; namespace?: string; queryParams?: QueryParameters; } | - |
__namedParameters.cluster? | string | Cluster name |
__namedParameters.initialData? | K | Seed 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 KubeObject | Class to instantiate the object with |
__namedParameters.name | string | Object name |
__namedParameters.namespace? | string | Object namespace |
__namedParameters.queryParams? | QueryParameters | - |
Returns
[K | null, ApiError | null] & QueryResponse<K, ApiError>