Interface ParamOptions

Action's parameter options

interface ParamOptions {
    description?: string;
    isCollection?: boolean;
    label?: string;
    lengthInCharacter?: boolean;
    max?: string | number;
    message?: string;
    metaName?: string;
    min?: string | number;
    pattern?: string | RegExp;
    required?: boolean;
    type: string;
}

Properties

description? isCollection? label? lengthInCharacter? max? message? metaName? min? pattern? required? type

Properties

Optional description

description?: string

the detail info of parameter

Optional isCollection

isCollection?: boolean

Whether the parameter is a collection type

Optional label

label?: string

label of parameter

Optional lengthInCharacter

lengthInCharacter?: boolean

Whether to calculate the length of the string in characters

Optional max

max?: string | number

Maximum value of the parameter

Optional message

message?: string

Prompt message returned when the parameter is illegal

Optional metaName

metaName?: string

The schema object name to which the parameter is bound, used only when type equal Object

Optional min

min?: string | number

Minimum value of the parameter

Optional pattern

pattern?: string | RegExp

Matching pattern when parameter checking

Optional required

required?: boolean

Whether the parameter is required

type

type: string

Parameter type name, support: Boolean, String, Number, Date, Datetime, Object, Any, Class

Settings

Member Visibility

Theme

On This Page

descriptionisCollectionlabellengthInCharactermaxmessagemetaNameminpatternrequiredtype