Skip to content

enumMember

Import from @varavel/vdl-plugin-sdk/testing.

function enumMember(
   name, 
   value, 
   overrides?): EnumMember;

Creates an EnumMember with the given name and literal value.

Pass overrides to set annotations or doc.

Parameters

Parameter Type Description
name string Enum member name.
value LiteralValue Enum member literal value.
overrides Partial\<Omit\<EnumMember, "position" | "name" | "annotations" | "value">> & object Optional member overrides.

Returns

EnumMember

An EnumMember with defaults applied.

Example

enumMember("ADMIN", stringLiteral("admin"));
// returns an enum member named "ADMIN"