A parameter that can be set and used in evaluated code.
@id: stencila:Parameter
Parent: Variable
| Name | @id | Type | Description | Inherited from |
|---|---|---|---|---|
| name (required) | schema:name | string |
The name of the variable. | Variable |
| type (required) | schema:type | enum{Parameter} |
The name of the type. | Entity |
| default | schema:defaultValue | Node |
The default value of the parameter. | Parameter |
| id | schema:id | string |
The identifier for this item. | Entity |
| isExtensible | stencila:isExtensible | boolean |
Indicates that this parameter is variadic and can accept multiple named arguments. | Parameter |
| isReadonly | schema:readonlyValue | boolean |
Whether or not a property is mutable. Default is false. | Variable |
| isRequired | schema:valueRequired | boolean |
Is this parameter required, if not it should have a default or default is assumed to be null. | Parameter |
| isVariadic | stencila:isVariadic | boolean |
Indicates that this parameter is variadic and can accept multiple arguments. | Parameter |
| meta | stencila:meta | object |
Metadata associated with this item. | Entity |
| validator | stencila:validator | ValidatorTypes
|
The validator that the value is validated against. | Variable |
| value | schema:value | Node |
The value of the variable. | Variable |
Note: This documentation was autogenerated
from Parameter.schema.yaml. Please
help improve these docs (and show how we humans 💁 can do better than bots 🤖!) by creating a Markdown documentation file🙏