Parameter

A parameter of a document or function.

This schema type is marked as experimental 🧪 and is subject to change.

Properties

Name	@id	Type	Description	Inherited from
name	schema:name	string	The name of the parameter. See note 1.	Parameter
default	schema:defaultValue	Node	The default value of the parameter.	Parameter
executeDigest	stencila:executeDigest	string	The SHA-256 digest of the value property the last time the node was executed. See note 2.	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
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.	Parameter
value	schema:value	Node	The current value of the parameter.	Parameter

Notes

1. name : This regex allows for snake_case and camelCase names but excludes PascalCase for names.
2. executeDigest : Used to determine whether it is necessary to re-execute the node (i.e to assign a variable within the document session having name and value).

Related

• Parent: Entity
• Descendants: None

Available as

• JSON-LD
• JSON Schema
• Python class Parameter
• TypeScript interface Parameter
• R class Parameter
• Rust struct Parameter

Source

This documentation was generated from Parameter.schema.yaml.