Skip to content

vue-qs v0.2.8


vue-qs / parseAsStringEnum

Function: parseAsStringEnum() ​

parseAsStringEnum<Enum>(validValues): ParserBuilder<Enum>

Defined in: parsers.ts:291

String enum. Values outside the enum are treated as invalid.

Type Parameters ​

Enum ​

Enum extends string

Parameters ​

validValues ​

readonly Enum[]

Returns ​

ParserBuilder<Enum>

Example ​

ts
enum Direction { up = 'UP', down = 'DOWN' }
const direction = useQueryState('dir', parseAsStringEnum<Direction>(Object.values(Direction)))

Released under the MIT License. Questions or ideas? Join the GitHub Discussions.