web / lib/hooks/use-dataset-enum-fields
lib/hooks/use-dataset-enum-fields
React Query hook for fetching enum field metadata from a dataset.
Used by categorical filter components to display enum field dropdowns.
Extracts fields where isEnumCandidate is true from the dataset’s
fieldMetadata and selects the top N fields by cardinality heuristics.
Interfaces
EnumField
Represents an enum field ready for display in the filter UI.
Properties
path
path:
string
Field path in the data (e.g., “status”, “category”)
label
label:
string
Human-readable label derived from the path
values
values:
object[]
Available values with counts
value
value:
string
count
count:
number
percent
percent:
number
cardinality
cardinality:
number
Number of unique values
Variables
datasetEnumFieldsKeys
constdatasetEnumFieldsKeys:object
Type Declaration
all
all: readonly [
"dataset-enum-fields"]
byDataset()
byDataset: (
datasetId) => readonly ["dataset-enum-fields",string|null]
Parameters
datasetId
string | null
Returns
readonly ["dataset-enum-fields", string | null]
Functions
useDatasetEnumFieldsQuery()
useDatasetEnumFieldsQuery(
datasetId,maxFields?):UseQueryResult<EnumField[],Error>
Hook to fetch enum fields for a dataset.
Returns the top N enum candidate fields from the dataset’s fieldMetadata, ready for display in categorical filter dropdowns.
Parameters
datasetId
The dataset ID to fetch enum fields for
string | null
maxFields?
number = 5
Maximum number of fields to return (default: 5)
Returns
UseQueryResult<EnumField[], Error>