schema

Parameter

A parameter that can be set and used in evaluated code.

Properties

Name	@id	Type	Description	Inherited from
name	schema:name	string	The name of the variable. See note 1.	Variable
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. See note 2.	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

Related

• Parent: Variable
• Descendants: None

Notes

1. name : This regex allows for snake_case and camelCase names but excludes PascalCase for names.
2. isReadonly : If isReadonly is true and value is defined then changes to value should not be allowed.

Available as

• JSON-LD
• JSON Schema
• Python class
• TypeScript class
• R class

Source

This documentation was generated from Parameter.schema.yaml.

This site is open source. Improve this page.