Interface SectionParameter<T, M>

Un paramètre de section

interface SectionParameter<T, M> {
    controlledValues?: SectionParameterTypes[T][];
    defaultValue: M extends true
        ? SectionParameterTypes[T][]
        : SectionParameterTypes[T];
    editor?: SectionParameterEditor<T>;
    help: string;
    max?: number;
    min?: number;
    multiple?: M;
    nbValuesMax?: number;
    nbValuesMin?: number;
    type: T;
    validate?: SectionParameterValidate<T, M>;
}

Type Parameters

Properties

controlledValues? defaultValue editor? help max? min? multiple? nbValuesMax? nbValuesMin? type validate?

Properties

OptionalcontrolledValues

controlledValues?: SectionParameterTypes[T][]

Pour imposer une liste de valeurs possibles, doit inclure defaultValue

defaultValue

defaultValue: M extends true
    ? SectionParameterTypes[T][]
    : SectionParameterTypes[T]

La valeur par défaut

Optionaleditor

editor?: SectionParameterEditor<T>

Une fonction pour éditer le paramètre

help

help: string

Le message d’aide à la saisie

Optionalmax

max?: number

un max imposé pour les types integer|number

Optionalmin

min?: number

un min imposé pour les types integer|number

Optionalmultiple

multiple?: M

true si la valeur est multiple (Array)

OptionalnbValuesMax

nbValuesMax?: number

Un nb max de valeurs (ignoré si !multiple)

OptionalnbValuesMin

nbValuesMin?: number

Un nb minimal de valeurs (ignoré si !multiple)

type

type: T

Le type de paramètre boolean|integer|number|string, cf SectionParameterTypes

Optionalvalidate

validate?: SectionParameterValidate<T, M>

Une fonction de validation

Settings

Member Visibility

On This Page

Properties