Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomParameter<ParameterTypeLiteral>

Accepted parameters can be assigned to a component. This is the type definition of the parameter, and does not store the value. Components which accept parameters will have a defineParameter implementation.

param name

The name of the parameter.

param type

The type of the parameter. If using an enum, use the CustomEnumParameter class.

param defaultValue

The default value of the parameter.

param description

A description of the parameter.

Type Parameters

Hierarchy

Implements

  • Generable

Index

Constructors

  • new CustomParameter<ParameterTypeLiteral>(name: string, type: ParameterTypeLiteral, defaultValue?: unknown, description?: string): CustomParameter<ParameterTypeLiteral>

Properties

defaultValue?: unknown
description?: string
name: string
type: ParameterTypeLiteral

Accessors

Methods

Generated using TypeDoc