enumDef
Import from @varavel/vdl-plugin-sdk/testing.
function enumDef(
name,
enumValueType,
members,
overrides?
): EnumDef;
Creates an EnumDef with the given name, value type, and members.
Pass overrides to set annotations or doc.
Parameters
| Parameter | Type | Description |
|---|---|---|
name | string | Enum name. |
enumValueType | EnumValueType | Underlying enum storage type. |
members | EnumMember[] | Enum members. |
overrides? | Partial<Omit<EnumDef, "position" | "name" | "annotations" | "enumType" | "members">> & object | Optional enum overrides. |
Returns
An EnumDef with defaults applied.
Example
enumDef("Role", "string", [
enumMember("ADMIN", stringLiteral("admin")),
]);
// returns an enum definition named "Role"