Function
A function with a name, which might take Parameters and return a value of a certain type.
This type is marked as experimental and is likely to change.
Properties
The Function type has these properties:
| Name | Description | Type | Inherited from | JSON-LD @id |
Aliases |
|---|---|---|---|---|---|
id |
The identifier for this item. | String |
Entity |
schema:id |
- |
name |
The name of the function. | String |
- | schema:name |
- |
parameters |
The parameters of the function. | Parameter* |
- | stencila:parameters |
parameter |
returns |
The return type of the function. | Validator |
- | stencila:returns |
- |
Related
The Function type is related to these types:
- Parents:
Entity - Children: none
Formats
The Function type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:
| Format | Encoding | Decoding | Support | Notes |
|---|---|---|---|---|
| DOM HTML | 🟢 No loss | |||
| HTML | 🔷 Low loss | |||
| JATS | ||||
| Markdown | ⚠️ High loss | |||
| Stencila Markdown | ⚠️ High loss | |||
| Quarto Markdown | ⚠️ High loss | |||
| MyST Markdown | ⚠️ High loss | |||
| LLM Markdown | ⚠️ High loss | |||
| LaTeX | 🔷 Low loss | 🔷 Low loss | ||
| 🔷 Low loss | ||||
| Plain text | ⚠️ High loss | |||
| IPYNB | 🔷 Low loss | 🔷 Low loss | ||
| Microsoft Word DOCX | 🔷 Low loss | 🔷 Low loss | ||
| OpenDocument ODT | 🔷 Low loss | 🔷 Low loss | ||
| TeX | 🔷 Low loss | 🔷 Low loss | ||
| JSON | 🟢 No loss | 🟢 No loss | ||
| JSON+Zip | 🟢 No loss | 🟢 No loss | ||
| JSON5 | 🟢 No loss | 🟢 No loss | ||
| JSON-LD | 🟢 No loss | 🟢 No loss | ||
| CBOR | 🟢 No loss | 🟢 No loss | ||
| CBOR+Zstandard | 🟢 No loss | 🟢 No loss | ||
| YAML | 🟢 No loss | 🟢 No loss | ||
| Lexical JSON | 🔷 Low loss | 🔷 Low loss | ||
| Koenig JSON | 🔷 Low loss | 🔷 Low loss | ||
| Pandoc AST | 🔷 Low loss | 🔷 Low loss | ||
| Directory | ||||
| Stencila Web Bundle | ||||
| Debug | 🔷 Low loss |
Bindings
The Function type is represented in:
- JSON-LD
- JSON Schema
- Python class
Function - Rust struct
Function - TypeScript class
Function
Source
This documentation was generated from Function.yaml by docs_types.rs.