Appearance
LuaApiEntry
Type: Object
One entry of a role's ctx.* surface, for editor completions and hover
Fields
| Name | Type | Args | Description | Deprecated |
|---|---|---|---|---|
| documentation | String | The declaration's intent description, when it carries one | ||
| handleType | String | On a FUNCTION, the handle type the call returns; on a HANDLE_METHOD, the type it belongs to. Pair the two to resolve local d = ctx.device.get(…) and offer d:http. | ||
| isAsync | Boolean! | True when the call returns (ok, res) — bind TWO values. Binding one binds the boolean. | ||
| kind | LuaApiEntryKind! | Whether the entry is a function, a namespace, or a handle method | ||
| path | String! | Fully-qualified path, e.g. "ctx.graphql.query" | ||
| signature | String! | Type signature; async functions show the (ok, res) tuple |