This is an executable type used in Stencila Schema for arguments passed to a CallBlock.

It extends Parameter with executable code so an argument's value can be computed dynamically rather than supplied only as a static value. This supports parameterized document calls and reusable document components.

Key properties include the argument name, code, value, and programmingLanguage.

This type is marked as experimental and is likely to change.

Properties

The CallArgument type has these properties:

Name	Description	Type	Inherited from
`value`	The current value of the argument.	`Node`	-
`code`	The code to be evaluated for the parameter.	`Cord`	-
`programmingLanguage`	The programming language of the code.	`String`	-
`name`	The name of the parameter.	`String`	`Parameter`
`label`	A short label for the parameter.	`String`	`Parameter`
`default`	The default value of the parameter.	`Node`	`Parameter`
`validator`	The validator that the value is validated against.	`Validator`	`Parameter`
`derivedFrom`	The dotted path to the object (e.g. a database table column) that the parameter should be derived from	`String`	`Parameter`
`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 CallArgument type is related to these types:

Parents: Parameter

Children: none

Bindings

The CallArgument type is represented in:

JSON-LD

JSON Schema

Python class CallArgument

Rust struct CallArgument

TypeScript class CallArgument

Testing

During property-based (a.k.a generative) testing, the properties of the CallArgument 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()`
`code`	Min+	Generate a simple fixed string of code.	`Cord::from("code")`
	Low+	Generate a random string of up to 10 alphanumeric characters.	`r"[a-zA-Z0-9]{1,10}".prop_map(Cord::from)`
	High+	Generate a random string of up to 100 characters (excluding control characters).	`r"[^\p{C}]{1,100}".prop_map(Cord::from)`
	Max	Generate an arbitrary string.	`String::arbitrary().prop_map(Cord::from)`

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

Properties

Related

Bindings

Testing