schema

Function

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

Properties

Name	@id	Type	Description	Inherited from
id	schema:id	string	The identifier for this item.	Entity
meta	stencila:meta	object	Metadata associated with this item.	Entity
name	schema:name	string	The name of the function. See note 1.	Function
parameters	stencila:parameters	Array of Parameter	The parameters of the function.	Function
returns	stencila:returns	ValidatorTypes	The return type of the function.	Function

Related

• Parent: Entity
• Descendants: None

Notes

1. name : 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.

Available as

• JSON-LD
• JSON Schema
• Python class
• TypeScript class
• R class

Source

This documentation was generated from Function.schema.yaml.

This site is open source. Improve this page.