Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ParameterSchema

Properties required to build a Parameter object

interface

Hierarchy

  • ParameterSchema

Index

Properties

Properties

Optional choices

choices?: string[]

List of value choices

remarks

Available only when type is set to "string"

Optional description

description?: string

Parameter description

name

name: string

Parameter name

optional

optional: boolean

Whether this parameter is optional

type

type: ParameterType

Type of parameter data

Generated using TypeDoc