package fzf

  1. Overview
  2. Docs
package fzf
Legend:
Library
Module
Module type
Parameter
Class
Class type

Pick_from instructs Fzf to choose from a given input and perhaps select an output that wasn't the string selected.

type _ t =
  1. | Map : 'a Core.String.Map.t -> 'a t
    (*

    Map map will sort the displayed map keys lexicographically and return the corresponding value.

    *)
  2. | Assoc : (string * 'a) list -> 'a t
    (*

    Assoc list will display list in an order preserving way, returning the corresponding 'a upon selection.

    *)
  3. | Inputs : string list -> string t
    (*

    Inputs strings will display strings to the user, order preserving. The string selected is returned.

    *)
  4. | Command_output : string -> string t
    (*

    Command_output command will execute command and display the results for selection, this is useful for interactive selection driven from another executable:

    • command will be run every time the query string changes.
    • All occurrences of "q" in command will be replaced with the current value of fzf's query string.

    The selected line is returned as a string.

    This mechanism uses the --bind flag with the change event (see `man 1 fzf` for more information about query strings and preview/bind).

    *)
  5. | Streaming : 'a Streaming.t -> 'a t
    (*

    Streaming will read encoded strings from reader until the pipe is closed.

    *)
val map : 'a Core.String.Map.t -> 'a t
val assoc : (string * 'a) list -> 'a t
val inputs : string list -> string t
val command_output : string -> string t
val streaming : 'a Streaming.t -> 'a t
module Of_stringable : sig ... end