Skip to content

LuaSample ​

Type: Object

A Lua sample script with its source

Fields ​

NameTypeArgsDescriptionDeprecated
apis[String!]!Every ctx.* function the sample calls, derived from its source rather than declared
descriptionString!One line saying what the sample demonstrates
entryStringThe export to call on a DISPATCHING surface — handler for a webhook, a method name for a custom app. Null when the surface evaluates the chunk and uses its return value instead.
idString!Stable identifier, e.g. "graphql-list-customers"
roleLuaScriptRole!Which scripting surface the sample is written against
sourceString!The runnable Lua source, front-matter stripped
tierLuaSampleTier!RECIPE for task-shaped examples, SNIPPET for one function
titleString!Short human-readable name, for a menu entry

Connect machines, automate workflows, and build custom apps for print production.