Interface Argument<TypeName, ValueType, ValidatorParams>

interface Argument<TypeName, ValueType, ValidatorParams> {
    argumentType: TypeName;
    defaultVisible?: boolean;
    description?: string;
    displayName?: string;
    hideIcon?: boolean;
    userProvided?: boolean;
    validatorParams?: ValidatorParams;
    value?: ValueType;
}

Type Parameters

  • TypeName extends ArgumentTypeName
  • ValueType = unknown
  • ValidatorParams = Record<string, unknown>

Properties

argumentType defaultVisible? description? displayName? hideIcon? userProvided? validatorParams? value?

Properties

argumentType

argumentType: TypeName

Optional defaultVisible

defaultVisible?: boolean

Can be used to hide certain advanced arguments from the UI by default. Users can still reveal them by clicking the "show more" button. Defaults to true.

Optional description

description?: string

Tooltip text for the argument. If displayName is set to empty string, the tooltip text is displayed in line.

Optional displayName

displayName?: string

Display name for the argument. If not provided, the Argument key is displayed in title case.

Optional hideIcon

hideIcon?: boolean

Whether to hide the icon left to the argument. Defaults to false.

Optional userProvided

userProvided?: boolean

Optional validatorParams

validatorParams?: ValidatorParams

Can be used to validate user input before proof generation as well as proactive filtering of options, such as PCDs, in the UI.

Optional value

value?: ValueType

Settings

Member Visibility

Theme

On This Page

argumentTypedefaultVisibledescriptiondisplayNamehideIconuserProvidedvalidatorParamsvalue

Generated using TypeDoc