← API reference
CANONICAL TYPE REFERENCE

LuaApiEntry

One entry of a role's ctx.* surface, for editor completions and hover

pathString!

Fully-qualified path, e.g. "ctx.graphql.query"

Whether the entry is a function, a namespace, or a handle method

signatureString!

Type signature; async functions show the (ok, res) tuple

The declaration's intent description, when it carries one

isAsyncBoolean!

True when the call returns (ok, res) — bind TWO values. Binding one binds the boolean.

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.

View exact SDL
"""One entry of a role's ctx.* surface, for editor completions and hover"""
type LuaApiEntry {
  """
  Fully-qualified path, e.g. "ctx.graphql.query"
  """
  path: String!
  """Whether the entry is a function, a namespace, or a handle method"""
  kind: LuaApiEntryKind!
  """Type signature; async functions show the (ok, res) tuple"""
  signature: String!
  """The declaration's intent description, when it carries one"""
  documentation: String
  """
  True when the call returns (ok, res) — bind TWO values. Binding one binds the boolean.
  """
  isAsync: Boolean!
  """
  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`.
  """
  handleType: String
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.