Skip to content

returns

Source

Hook for stopping parsing and returning a given value instead of the public context data. Returns the value as is without parsing or rendering as compared to the return hook which renders / parses by default.

Inputs

Name Type Default Required Description
value Any None False The value to return.

Arguments

Position Argument Type
1 value Any

Returns

Any

Examples

The returns hook stops parsing and returns whatever string value

foo:
  bar: baz
returns->: foo

bar: baz

The returns hook stops parsing

foo: bar
returns->: foo  # Does not render by default vs `return` hook which does

foo