commands/slash

Import

Import

import * as api from "@fungi.computer/parakeet/slash";

Exports

Kind	Export	Description
Ttype alias	SlashCommand	One slash command as every Parakeet renderer lists it.
Ttype alias	KeyBindingRow	One key binding as help and hint surfaces list it.
Ttype alias	SlashParse	How one composer draft maps to a command.
Ttype alias	SlashCommandItem	One command offered while the alias is being typed.
Ttype alias	SlashWordItem	One argument word offered after the alias.
Ttype alias	SlashCompletion	What a composer shows for the current draft.
Ttype alias	FuzzyMatch	How well one candidate matched a query; lower tiers and spreads rank first.
fnfunction	keyLabel()	Human key labels from Whistle bindings, with the platform’s modifier name.
fnfunction	slashRegistry()	Every slash alias in the live graph, with the keys bound to its command.
fnfunction	keyBindings()	Every bound key in the live graph, grouped by command.
fnfunction	parseSlashDraft()	Parse one draft against the registry; only a leading / names a command.
fnfunction	fuzzyMatch()	Fuzzy match: a prefix beats a word start beats a substring beats an in-order subsequence; tighter subsequences rank first.
fnfunction	completeSlash()	Rank completions for one draft; renderers draw exactly these rows.

SlashCommandTtype alias

Signature

type SlashCommand = Readonly<{
  alias: string;
  commandId: string;
  command: WhistleCommandKey;
  consumesDraft?: boolean;
  title: string;
  description?: string;
  category: string;
  order: number;
  grammar?: WhistleSlashArguments;
  keys: readonly string[];
  availability: WhistleAvailability;
}>;

One slash command as every Parakeet renderer lists it.

---

KeyBindingRowTtype alias

Signature

type KeyBindingRow = Readonly<{
  commandId: string;
  command: WhistleCommandKey;
  keys: string;
  title: string;
  order: number;
}>;

One key binding as help and hint surfaces list it.

---

SlashParseTtype alias

Signature

type SlashParse =
  | Readonly<{
      kind: "prompt";
    }>
  | Readonly<{
      kind: "command";
      command: SlashCommand;
      arguments?: WhistleJsonObject;
      requestIdField?: string;
    }>
  | Readonly<{
      kind: "invalid";
      message: string;
    }>;

How one composer draft maps to a command.

---

SlashCommandItemTtype alias

Signature

type SlashCommandItem = Readonly<{
  command: SlashCommand;
  label: string;
  matches: readonly number[];
  insert: string;
}>;

One command offered while the alias is being typed.

---

SlashWordItemTtype alias

Signature

type SlashWordItem = Readonly<{
  word: WhistleSlashWord;
  label: string;
  matches: readonly number[];
  insert: string;
}>;

One argument word offered after the alias.

---

SlashCompletionTtype alias

Signature

type SlashCompletion =
  | Readonly<{
      kind: "none";
    }>
  | Readonly<{
      kind: "commands";
      query: string;
      items: readonly SlashCommandItem[];
    }>
  | Readonly<{
      kind: "arguments";
      command: SlashCommand;
      query: string;
      hint: string;
      items: readonly SlashWordItem[];
    }>;

What a composer shows for the current draft.

---

FuzzyMatchTtype alias

Signature

type FuzzyMatch = Readonly<{
  tier: number;
  spread: number;
  indices: number[];
}>;

How well one candidate matched a query; lower tiers and spreads rank first.

keyLabel()fnfunction

Signature

function keyLabel(binding, mac?): string;

Human key labels from Whistle bindings, with the platform’s modifier name.

Parameters

Parameter	Type
binding	string
mac	boolean

Returns

string

---

slashRegistry()fnfunction

Signature

function slashRegistry(snapshot): readonly Readonly<{
  alias: string;
  commandId: string;
  command: WhistleCommandKey;
  consumesDraft?: boolean;
  title: string;
  description?: string;
  category: string;
  order: number;
  grammar?: {
     hint: string;
     words?: readonly object[];
     text?: {
        field: string;
        arguments: {
         [key: string]:
           | string
           | number
           | boolean
           | readonly string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | ... 4 more ... | null)[] | { ...; } | null)[] | { ...; } | null)[] | { ...; } | ...[]
           | {
         [key: string]: string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | ... 4 more ... | null)[] | { ...; } | null)[] | { ...; } | null)[] | { ...; } | ...;
         }
           | null;
        };
        requestIdField?: string;
     };
  };
  keys: readonly string[];
  availability: WhistleAvailability;
}>[];

Every slash alias in the live graph, with the keys bound to its command.

Parameters

Parameter	Type
snapshot	WhistleSnapshot

Returns

readonly Readonly<{ alias: string; commandId: string; command: WhistleCommandKey; consumesDraft?: boolean; title: string; description?: string; category: string; order: number; grammar?: { hint: string; words?: readonly object[]; text?: { field: string; arguments: { [key: string]: | string | number | boolean | readonly string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | … 4 more … | null)[] | { …; } | null)[] | { …; } | null)[] | { …; } | …[] | { [key: string]: string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | … 4 more … | null)[] | { …; } | null)[] | { …; } | null)[] | { …; } | …; } | null; }; requestIdField?: string; }; }; keys: readonly string[]; availability: WhistleAvailability; }>[]

---

keyBindings()fnfunction

Signature

function keyBindings(snapshot): readonly Readonly<{
  commandId: string;
  command: WhistleCommandKey;
  keys: string;
  title: string;
  order: number;
}>[];

Every bound key in the live graph, grouped by command.

Parameters

Parameter	Type
snapshot	WhistleSnapshot

Returns

readonly Readonly<{ commandId: string; command: WhistleCommandKey; keys: string; title: string; order: number; }>[]

---

parseSlashDraft()fnfunction

Signature

function parseSlashDraft(registry, draft): SlashParse;

Parse one draft against the registry; only a leading / names a command.

Parameters

Parameter	Type
registry	readonly Readonly<{ alias: string; commandId: string; command: WhistleCommandKey; consumesDraft?: boolean; title: string; description?: string; category: string; order: number; grammar?: { hint: string; words?: readonly object[]; text?: { field: string; arguments: { [key: string]: | string | number | boolean | readonly string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | … 4 more … | null)[] | { …; } | null)[] | { …; } | null)[] | { …; } | …[] | { [key: string]: string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | … 4 more … | null)[] | { …; } | null)[] | { …; } | null)[] | { …; } | …; } | null; }; requestIdField?: string; }; }; keys: readonly string[]; availability: WhistleAvailability; }>[]
draft	string

Returns

SlashParse

---

fuzzyMatch()fnfunction

Signature

function fuzzyMatch(
  candidate,
  query,
):
  | Readonly<{
      tier: number;
      spread: number;
      indices: number[];
    }>
  | undefined;

Fuzzy match: a prefix beats a word start beats a substring beats an in-order subsequence; tighter subsequences rank first.

Parameters

Parameter	Type
candidate	string
query	string

Returns

| Readonly<{ tier: number; spread: number; indices: number[]; }> | undefined

---

completeSlash()fnfunction

Signature

function completeSlash(registry, draft, options?): SlashCompletion;

Rank completions for one draft; renderers draw exactly these rows.

Parameters

Parameter	Type
registry	readonly Readonly<{ alias: string; commandId: string; command: WhistleCommandKey; consumesDraft?: boolean; title: string; description?: string; category: string; order: number; grammar?: { hint: string; words?: readonly object[]; text?: { field: string; arguments: { [key: string]: | string | number | boolean | readonly string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | … 4 more … | null)[] | { …; } | null)[] | { …; } | null)[] | { …; } | …[] | { [key: string]: string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | … 4 more … | null)[] | { …; } | null)[] | { …; } | null)[] | { …; } | …; } | null; }; requestIdField?: string; }; }; keys: readonly string[]; availability: WhistleAvailability; }>[]
draft	string
options	Readonly<{ idleCategory?: string; }>

Returns

SlashCompletion