@effected/cli 0.19.0 → 0.21.0

package/ui.d.ts

@@ -4,7 +4,6 @@ import { Param } from "effect/cli";
 import { ReactElement, ReactNode } from "react";
 import { Key } from "ink";
 import { ColorLevel } from "@effected/env";
-//#region src/ui/CliUiLive.d.ts
 /**
  * Options for `CliUi.live`.
  *
@@ -178,8 +177,6 @@ interface LiveHandle<S> {
    */
   readonly close: Effect.Effect<void>;
 }
-//#endregion
-//#region src/ui/UiProvider.d.ts
 /**
  * What the kit's hooks read in a tree the kit did not mount: the theme, the glyph set, and optionally the size.
  *
@@ -245,8 +242,6 @@ interface UiProviderProps {
  * @public
  */
 export declare const UiProvider: (props: UiProviderProps) => ReactElement;
-//#endregion
-//#region src/ui/CliUi.d.ts
 /**
  * How a screen ends: with a result, or cancelled for a reason.
  *
@@ -489,7 +484,7 @@ export declare class CliUi {
    * so core renders its own message and `CliRuntime.main` exits `64`. Name the parameter with `flag` (the name
    * without dashes) or `argument` so that error can be built.
    *
-   * The options are {@link @effected/cli!CliPromptFallbackOptions}, the same as `CliPrompt.fallback`'s, and `clear`
+   * The options are `CliPromptFallbackOptions` (from `@effected/cli`), the same as `CliPrompt.fallback`'s, and `clear`
    * as for {@link CliUi.run}.
    *
    * It runs during parsing, whose environment is core's alone, so it reads `CliTheme` if one is there: with
@@ -598,8 +593,6 @@ export declare class CliUi {
    */
   static readonly map: <A, B>(screen: Screen<A>, f: (value: A) => B) => Screen<B>;
 }
-//#endregion
-//#region src/ui/UiKey.d.ts
 /**
  * The named keys a screen understands and a test can press.
  *
@@ -626,7 +619,7 @@ export type UiKey = {
   readonly char: string;
 };
 /**
- * Normalising Ink's input into {@link UiKey}s.
+ * Normalising Ink's input into {@link (UiKey:type)}s.
  *
  * @public
  */
@@ -641,8 +634,6 @@ export declare const UiKey: {
   /** Typed text. */
   readonly char: (char: string) => UiKey;
 };
-//#endregion
-//#region src/ui/KeyTable.d.ts
 /**
  * One row of a {@link KeyTable}: the keys that trigger an action, and the help line that names it.
  *
@@ -751,8 +742,6 @@ export declare class KeyTable<Action> {
  * @public
  */
 export declare const useKeys: <Action>(table: KeyTable<Action>, dispatch: (action: Action) => void, options?: UseKeysOptions) => void;
-//#endregion
-//#region src/ui/Confirm.d.ts
 /**
  * An extra on/off row a {@link Confirm} hosts beneath its yes/no answer.
  *
@@ -903,8 +892,6 @@ export declare class Confirm {
    */
   static readonly screen: <K extends string>(options: ConfirmScreenOptions<K>) => Screen<ConfirmResult<K>>;
 }
-//#endregion
-//#region src/ui/DocView.d.ts
 /**
  * Props of {@link DocView}.
  *
@@ -941,8 +928,6 @@ interface DocViewProps {
  * @public
  */
 export declare const DocView: (props: DocViewProps) => ReactElement;
-//#endregion
-//#region src/ui/KeyHelp.d.ts
 /**
  * Props of {@link KeyHelp}.
  *
@@ -969,8 +954,6 @@ interface KeyHelpProps {
  * @public
  */
 export declare const KeyHelp: (props: KeyHelpProps) => ReactElement;
-//#endregion
-//#region src/ui/Viewport.d.ts
 /**
  * Where a viewport is: the selected item, the first item in view, how many items fit, and how many there are.
  *
@@ -1069,8 +1052,6 @@ export declare class Viewport {
    */
   static readonly View: (props: ViewportViewProps) => ReactElement;
 }
-//#endregion
-//#region src/ui/MultiSelect.d.ts
 /**
  * One item of a {@link MultiSelect} section.
  *
@@ -1234,8 +1215,6 @@ export declare class MultiSelect {
    */
   static readonly screen: <A>(options: MultiSelectScreenOptions<A>) => Screen<ReadonlyArray<A>>;
 }
-//#endregion
-//#region src/ui/Select.d.ts
 /**
  * One choice of a {@link Select}.
  *
@@ -1393,8 +1372,6 @@ export declare class Select {
    */
   static readonly screen: <A>(options: SelectScreenOptions<A>) => Screen<A>;
 }
-//#endregion
-//#region src/ui/Tabs.d.ts
 /**
  * What a key does to a {@link Tabs} row: move to the previous or next tab (wrapping), or jump to one by index.
  *
@@ -1482,8 +1459,6 @@ export declare class Tabs {
    */
   static readonly View: <N extends string>(props: TabsProps<N>) => ReactElement;
 }
-//#endregion
-//#region src/ui/TextInput.d.ts
 /**
  * Where a {@link TextInput} is: its value, the cursor within it, and whether enter was pressed.
  *
@@ -1542,8 +1517,8 @@ interface TextInputScreenOptions {
    * does the scrollback; erase the frame as well with `clear: true` on the run when even the mask's length should not
    * stay behind.
    *
-   * The message `validate` returns is drawn as it is, unmasked: a message that echoes the value (`"ghp_abc is a
-   * token"`) draws the secret in the frame. Say what is wrong without quoting the value.
+   * The message `validate` returns is drawn as it is, unmasked: a message that echoes the value
+   * (`"ghp_abc is a token"`) draws the secret in the frame. Say what is wrong without quoting the value.
    */
   readonly mask?: string | true | ((value: string) => boolean);
 }
@@ -1629,8 +1604,6 @@ export declare class TextInput {
    */
   static readonly screen: (options: TextInputScreenOptions) => Screen<string>;
 }
-//#endregion
-//#region src/ui/Toggle.d.ts
 /**
  * Props of {@link Toggle.View}.
  *
@@ -1659,8 +1632,6 @@ export declare class Toggle {
    */
   static readonly View: (props: ToggleViewProps) => ReactElement;
 }
-//#endregion
-//#region src/ui/UiStreams.d.ts
 /**
  * The streams a screen mounts on: Node streams, because Ink's stream contract is Node's.
  *
@@ -1693,10 +1664,8 @@ declare const UiStreams_base: Context.Reference<UiStreamsShape>;
  * @public
  */
 export declare class UiStreams extends UiStreams_base {}
-//#endregion
-//#region src/ui/UiTheme.d.ts
 /**
- * The styling props of an Ink `Text` that a {@link @effected/cli!Style} maps to.
+ * The styling props of an Ink `Text` that a `Style` (from `@effected/cli`) maps to.
  *
  * @public
  */
@@ -1812,6 +1781,5 @@ export declare const Styled: (props: StyledProps) => ReactElement;
  * @public
  */
 export declare const useTerminalSize: () => TerminalSize;
-//#endregion
 export type { Binding, CliUiFallbackOptions, CliUiPromptOptions, CliUiRunOptions, ConfirmAction, ConfirmInitOptions, ConfirmResult, ConfirmScreenOptions, ConfirmState, ConfirmToggle, ConfirmViewProps, DocViewProps, InkTextProps, KeyHelpProps, KeyHelpRow, KeyName, LiveHandle, LiveOptions, MultiSelectAction, MultiSelectInitOptions, MultiSelectItem, MultiSelectScreenOptions, MultiSelectSection, MultiSelectState, MultiSelectViewProps, Screen, ScreenControl, SelectAction, SelectChoice, SelectInitOptions, SelectScreenOptions, SelectState, SelectViewProps, StyledProps, Tab, TabsAction, TabsProps, TerminalSize, TextInputInitOptions, TextInputScreenOptions, TextInputState, TextInputViewProps, ToggleViewProps, UiContextValue, UiProviderProps, UiStreamsShape, UseKeysOptions, ViewportMove, ViewportRow, ViewportState, ViewportViewProps };
 //# sourceMappingURL=ui.d.ts.map