Parameter: A parameter that can be set and used in evaluated code.

In stencilaschema: Bindings for Stencila Schema

Description

A parameter that can be set and used in evaluated code.

Usage

Parameter(
  name,
  default,
  id,
  isExtensible,
  isReadonly,
  isRequired,
  isVariadic,
  meta,
  validator,
  value
)

Arguments

name	The name of the variable. Required.
default	The default value of the parameter.
id	The identifier for this item.
isExtensible	Indicates that this parameter is variadic and can accept multiple named arguments.
isReadonly	Whether or not a property is mutable. Default is false.
isRequired	Is this parameter required, if not it should have a default or default is assumed to be null.
isVariadic	Indicates that this parameter is variadic and can accept multiple arguments.
meta	Metadata associated with this item.
validator	The validator that the value is validated against.
value	The value of the variable.

Value

A list of class Parameter

See Also

Variable

stencilaschema documentation built on Feb. 22, 2021, 5:05 p.m.