API reference
caique
Every export of caique, with its signature and doc comment: processRuntime, ask, projection, resolvePrompts, localise, decide and 17 more, plus 27 types.
caique — prompts that are flags first. The first working slice is decide(): the pure
rule that decides whether a person can be asked at all, which is what keeps a CLI built
on this from hanging when an agent runs it. Widgets and the two façades follow; see
.sdlc/intents/caique/.
import { processRuntime, ask, projection, … } from 'caique';Constants
processRuntime
What a real process looks like. Callers that have not got one pass their own.
const processRuntime: () => Runtime;Re-exported
Documented on the page of the entry point that declares them.
| Export | Kind | Documented in |
|---|---|---|
ask | function | caique/ask |
askList | function | caique/raw |
bindings | function | caique/keys |
canonical | function | caique/keys |
canReadKeys | function | caique/keys |
canRender | function | caique/raw |
createIo | function | caique/terminal |
decide | function | caique/decide |
decode | function | caique/keys |
flagOf | function | caique/spec |
keyOf | function | caique/raw |
match | function | caique/keys |
problemWith | function | caique/spec |
projection | function | caique/ask |
readKeys | function | caique/keys |
renderList | function | caique/raw |
resolvePrompts | function | caique/binding |
specOf | function | caique/keys |
KeysError | class | caique/keys |
BUILT_IN_KINDS | const | caique/spec |
localise | const | caique/binding |
streamsOf | const | caique/terminal |
Binding | interface | caique/keys |
BoundPrompt | interface | caique/spec |
Choice | interface | caique/spec |
DecideInput | interface | caique/decide |
Decision | interface | caique/decide |
Flags | interface | caique/decide |
Io | interface | caique/ask |
KeyPress | interface | caique/keys |
KeyStream | interface | caique/raw |
PromptableOption | interface | caique/binding |
PromptSpec | interface | caique/spec |
RawIo | interface | caique/raw |
Reader | interface | caique/ask |
ReadOptions | interface | caique/ask |
Resolved | interface | caique/binding |
ResolveFailure | interface | caique/binding |
ResolveInput | interface | caique/binding |
Runtime | interface | caique/decide |
Streams | interface | caique/terminal |
Writer | interface | caique/ask |
Answer | type | caique/ask |
Asked | type | caique/ask |
Key | type | caique/raw |
KeyInput | type | caique/keys |
Keymap | type | caique/keys |
KeysErrorCode | type | caique/keys |
PromptKind | type | caique/spec |