This is an executable type used in Stencila Schema for document parameters.

It extends Executable so parameters can carry validation, derivation, and execution-related behavior instead of being treated as passive metadata. This makes them suitable for interactive and reproducible documents.

Key properties include the parameter name, value, validator, derivation logic, and inherited execution metadata.

This type is marked as unstable and is subject to change.

Analogues

The following external types, elements, or nodes are similar to a Parameter:

JATS <parameter>

JSON Schema property with default: Approximate analogue for constrained input values, though Stencila parameters are executable document nodes rather than passive schema declarations.

Properties

The Parameter type has these properties:

Name	Description	Type	Inherited from
`name`	The name of the parameter.	`String`	-
`label`	A short label for the parameter.	`String`	-
`value`	The current value of the parameter.	`Node`	-
`default`	The default value of the parameter.	`Node`	-
`validator`	The validator that the value is validated against.	`Validator`	-
`derivedFrom`	The dotted path to the object (e.g. a database table column) that the parameter should be derived from	`String`	-
`executionMode`	Under which circumstances the node should be executed.	`ExecutionMode`	`Executable`
`compilationDigest`	A digest of the content, semantics and dependencies of the node.	`CompilationDigest`	`Executable`
`compilationMessages`	Messages generated while compiling the code.	`CompilationMessage`*	`Executable`
`executionDigest`	The `compilationDigest` of the node when it was last executed.	`CompilationDigest`	`Executable`
`executionDependencies`	The upstream dependencies of this node.	`ExecutionDependency`*	`Executable`
`executionDependants`	The downstream dependants of this node.	`ExecutionDependant`*	`Executable`
`executionTags`	Tags in the code which affect its execution.	`ExecutionTag`*	`Executable`
`executionCount`	A count of the number of times that the node has been executed.	`Integer`	`Executable`
`executionRequired`	Whether, and why, the code requires execution or re-execution.	`ExecutionRequired`	`Executable`
`executionStatus`	Status of the most recent, including any current, execution.	`ExecutionStatus`	`Executable`
`executionInstance`	The id of the kernel instance that performed the last execution.	`String`	`Executable`
`executionEnded`	The timestamp when the last execution ended.	`Timestamp`	`Executable`
`executionDuration`	Duration of the last execution.	`Duration`	`Executable`
`executionMessages`	Messages emitted while executing the node.	`ExecutionMessage`*	`Executable`
`id`	The identifier for this item.	`String`	`Entity`

The Parameter type is related to these types:

Parents: Executable

Children: CallArgument

Bindings

The Parameter type is represented in:

JSON-LD

JSON Schema

Python class Parameter

Rust struct Parameter

TypeScript class Parameter

Testing

During property-based (a.k.a generative) testing, the properties of the Parameter type are generated using the following strategies.

Property	Complexity	Description	Strategy
`name`	Min+	Generate a fixed name.	`String::from("name")`
	Low+	Generate a random string of up to 10 alphanumeric characters (and at most one underscore to avoida clash with Markdown emphasis).	Regex `[a-zA-Z_][a-zA-Z0-9]{0,9}`
	High+	Generate a random string of up to 100 characters (excluding control characters).	Regex `[^\p{C}]{1,100}`
	Max	Generate an arbitrary string.	`String::arbitrary()`

This documentation was generated from Parameter.yaml by docs_types.rs.

Analogues

Properties

Related

Bindings

Testing