Skip to main content

Parameter

A parameter of a document or function.

This schema type is marked as experimental ๐Ÿงช and is subject to change.

Propertiesโ€‹

Name@idTypeDescriptionInherited from
nameschema:namestringThe name of the parameter. See note 1.Parameter
defaultschema:defaultValueNodeThe default value of the parameter.Parameter
executeDigeststencila:executeDigeststringThe SHA-256 digest of the value property the last time the node was executed. See note 2.Parameter
idschema:idstringThe identifier for this item.Entity
isExtensiblestencila:isExtensiblebooleanIndicates that this parameter is variadic and can accept multiple named arguments.Parameter
isRequiredschema:valueRequiredbooleanIs this parameter required, if not it should have a default or default is assumed to be null.Parameter
isVariadicstencila:isVariadicbooleanIndicates that this parameter is variadic and can accept multiple arguments.Parameter
metastencila:metaobjectMetadata associated with this item.Entity
validatorstencila:validatorValidatorTypesThe validator that the value is validated against.Parameter
valueschema:valueNodeThe 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).
  • Parent: Entity
  • Descendants: None

Available asโ€‹

Sourceโ€‹

This documentation was generated from Parameter.schema.yaml.