interaction

Import

Import

import * as api from "@fungi.computer/whistle/interaction";

Exports

Kind	Export	Description
Ttype alias	WhistleInteractionStatus	Where one interaction is in its life.
Ttype alias	WhistlePendingPrompt	The one pending question, with the sequence its answer must name.
Ttype alias	WhistleMessageNotice	A notice that carries a message line.
Ttype alias	WhistleHandoffNotice	A “continue elsewhere” notice.
Ttype alias	WhistleInteractionSnapshot	Everything a renderer needs to draw one interaction.
Ttype alias	WhistleInteractionHost	A renderer-neutral store behind one interaction dialog or panel.
fnfunction	createWhistleInteractionHost()	Own one interaction’s state for any renderer. Prompts and notices are parsed here, at the boundary where command-supplied data becomes UI.

WhistleInteractionStatusTtype alias

Signature

type WhistleInteractionStatus =
  "working" | "prompting" | "failed" | "done" | "cancelled";

Where one interaction is in its life.

---

WhistlePendingPromptTtype alias

Signature

type WhistlePendingPrompt = Readonly<{
  sequence: number;
  request: WhistlePrompt;
}>;

The one pending question, with the sequence its answer must name.

---

WhistleMessageNoticeTtype alias

Signature

type WhistleMessageNotice = Extract<
  WhistleNotice,
  Readonly<{
    type: "info" | "progress" | "success";
  }>
>;

A notice that carries a message line.

---

WhistleHandoffNoticeTtype alias

Signature

type WhistleHandoffNotice = Extract<
  WhistleNotice,
  Readonly<{
    type: "handoff";
  }>
>;

A “continue elsewhere” notice.

---

WhistleInteractionSnapshotTtype alias

Signature

type WhistleInteractionSnapshot = Readonly<{
  title: string;
  status: WhistleInteractionStatus;
  message?: WhistleMessageNotice;
  handoff?: WhistleHandoffNotice;
  links: readonly WhistleNoticeLink[];
  prompt?: WhistlePendingPrompt;
  failure?: string;
  retryable: boolean;
  closing?: WhistleMessageNotice;
}>;

Everything a renderer needs to draw one interaction.

---

WhistleInteractionHostTtype alias

Signature

type WhistleInteractionHost = Readonly<{
  snapshot: () => WhistleInteractionSnapshot;
  subscribe: (listener) => () => void;
  begin: () => WhistleInteractionSession;
  retry: () => void;
  answer: (sequence, value) => boolean;
  cancel: () => void;
}>;

A renderer-neutral store behind one interaction dialog or panel.

createWhistleInteractionHost()fnfunction

Signature

function createWhistleInteractionHost(options): WhistleInteractionHost;

Own one interaction’s state for any renderer. Prompts and notices are parsed here, at the boundary where command-supplied data becomes UI.

Parameters

Parameter	Type
options	Readonly<{ title: string; onEnd?: (end) => void; }>

Returns

WhistleInteractionHost

References

interactionTextLimit

Re-exports interactionTextLimit