@stolostron/multicluster-sdk/lib/api/useFleetClusterNames.d.ts

Provides extensions and APIs that dynamic plugins can use to leverage multicluster capabilities provided by Red Hat Advanced Cluster Management.

/**
 * Hook that returns names of managed clusters with optional filtering by cluster proxy addon and availability status.
 *
 * This hook watches ManagedCluster resources and by default filters them to only include clusters
 * that have both the label `feature.open-cluster-management.io/addon-cluster-proxy: available` AND
 * the condition `ManagedClusterConditionAvailable` with status `True`.
 *
 * @param returnAllClusters - Optional boolean to return all cluster names regardless of labels and conditions.
 *   Defaults to false. When false (default), only returns clusters with the
 *   'feature.open-cluster-management.io/addon-cluster-proxy: available' label AND
 *   'ManagedClusterConditionAvailable' status: 'True'.
 *   When true, returns all cluster names regardless of labels and conditions.
 *
 * @returns A tuple containing:
 *   - clusterNames: Array of cluster names (filtered by default, or all clusters if specified)
 *   - loaded: Boolean indicating if the resource watch has loaded
 *   - error: Any error that occurred during the watch operation
 *
 * @example
 * ```tsx
 * // Get only clusters with cluster proxy addon available AND ManagedClusterConditionAvailable: 'True' (default behavior)
 * const [availableClusterNames, loaded, error] = useFleetClusterNames()
 *
 * // Get all cluster names regardless of labels and conditions
 * const [allClusterNames, loaded, error] = useFleetClusterNames(true)
 *
 * // Explicitly filter by cluster proxy addon and availability (same as default)
 * const [filteredClusterNames, loaded, error] = useFleetClusterNames(false)
 *
 * if (!loaded) {
 *   return <Loading />
 * }
 *
 * if (error) {
 *   return <ErrorState error={error} />
 * }
 *
 * return (
 *   <div>
 *     {availableClusterNames.map(name => (
 *       <div key={name}>{name}</div>
 *     ))}
 *   </div>
 * )
 * ```
 */
export declare function useFleetClusterNames(returnAllClusters?: boolean): [string[], boolean, any];
//# sourceMappingURL=useFleetClusterNames.d.ts.map