Skip to main content

Function

A function with a name, which might take Parameters and return a value of a certain type.

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

Properties#

Name@idTypeDescriptionInherited from
idschema:idstringThe identifier for this item.Entity
metastencila:metaobjectMetadata associated with this item.Entity
nameschema:namestringThe name of the function. See note 1.Function
parametersstencila:parametersArray of ParameterThe parameters of the function.Function
returnsstencila:returnsValidatorTypesThe return type of the function.Function

Notes#

  1. name : !array('The name property is not required; this allows for anonymous functions (although these are not yet implemented in Stencila interpreters). The regex allows for snake_case and camelCase names but excludes PascalCase for parameter names.')

Related#

  • Parent: Entity
  • Descendants: None

Available as#

Source#

This documentation was generated from Function.schema.yaml.