Sake.Prompt.Spec (Sake v0.4.3)

Copy Markdown View Source

The compiled definition of a prompt.

mount is nil for a prompt the server declares itself, and {server, prefix, spec} for one it mounted (Sake.Server.mount/2): the server it came from, the mount's prefix, and the spec as that server has it. proxy is the Sake.Proxy whose upstream serves a proxied prompt; it has no module.

Summary

Types

t()

@type t() :: %Sake.Prompt.Spec{
  args: term(),
  authentication: term(),
  description: term(),
  icons: term(),
  meta: term(),
  module: term(),
  mount: term(),
  name: term(),
  proxy: term(),
  scopes: term(),
  title: term(),
  ttl: term()
}

Functions

to_wire(s, revision)

@spec to_wire(t(), String.t()) :: map()