vue-qs / createEnumCodec
Function: createEnumCodec()
createEnumCodec<
T>(allowedValues):QueryCodec<undefined|T>
Defined in: serializers.ts:262
Enum codec factory for handling string enum values Falls back to first enum value for invalid inputs
Type Parameters
T
T extends string
String literal union type
Parameters
allowedValues
readonly T[]
Array of allowed enum values
Returns
QueryCodec<undefined | T>
QueryCodec for the enum type
Example
ts
type SortOrder = 'asc' | 'desc';
const sort = queryRef('sort', {
defaultValue: 'asc',
codec: createEnumCodec<SortOrder>(['asc', 'desc'])
});
// URL: ?sort=desc
// Invalid values fall back to 'asc'