Class CustomEnumParameter

An enum parameter can be passed to a component.

param name: The name of the parameter.
param enumValues: The values of the enum.
param defaultValue: The optional default value of the parameter. Optional, but will be marked as required if not provided.
param description: An optional description of the parameter.

Hierarchy

CustomParameter<EnumParameterLiteral>
- CustomEnumParameter

Index

Constructors

constructor

Properties

Accessors

generableType

Methods

Constructors

constructor

new CustomEnumParameter(name: string, enumValues: string[], defaultValue?: unknown, description?: string): CustomEnumParameter

Overrides CustomParameter.constructor
- Defined in src/lib/Components/Parameters/exports/CustomEnumParameter.ts:18
Parameters
- name: string
- enumValues: string[]
- Optional defaultValue: unknown
- Optional description: string
Returns CustomEnumParameter

Properties

Optional defaultValue

defaultValue?: unknown

Optional description

description?: string

enumValues

enumValues: string[]

name

name: string

type

type: "enum"

Accessors

generableType

get generableType(): GenerableType

Overrides CustomParameter.generableType
- Defined in src/lib/Components/Parameters/exports/CustomEnumParameter.ts:35
Returns GenerableType

Methods

generate

generate(): CustomParameterShape<"enum">

Inherited from CustomParameter.generate
- Defined in src/lib/Components/Parameters/exports/CustomParameter.ts:40
Returns CustomParameterShape<"enum">

generateContents

generateContents(): CustomParameterContentsShape<"enum"> & { enum: string[] }

Overrides CustomParameter.generateContents
- Defined in src/lib/Components/Parameters/exports/CustomEnumParameter.ts:28
Returns CustomParameterContentsShape<"enum"> & { enum: string[] }

Generated using TypeDoc