Function: consult--process-collection

consult--process-collection is a byte-compiled function defined in consult.el.

Signature

(consult--process-collection BUILDER &rest PROPS &key MIN-INPUT DEBOUNCE THROTTLE TRANSFORM HIGHLIGHT &allow-other-keys)

Documentation

Asynchronous process pipeline.

BUILDER is the command line builder function, which takes the input string and must either return a list of command line arguments or a pair of the command line argument list and a highlighting function. TRANSFORM is an optional async function transforming the candidate. If HIGHLIGHT is non-nil, highlight the candidates. MIN-INPUT is passed to consult--async-min-input. THROTTLE and DEBOUNCE are passed to consult--async-throttle. Other PROPS are passed to make-process.

Source Code

;; Defined in ~/.emacs.d/elpa/consult-20260805.1130/consult.el
(cl-defun consult--process-collection (builder &rest props &key min-input
                                               debounce throttle transform
                                               highlight &allow-other-keys)
  "Asynchronous process pipeline.
BUILDER is the command line builder function, which takes the
input string and must either return a list of command line
arguments or a pair of the command line argument list and a
highlighting function.
TRANSFORM is an optional async function transforming the candidate.
If HIGHLIGHT is non-nil, highlight the candidates.
MIN-INPUT is passed to `consult--async-min-input'.
THROTTLE and DEBOUNCE are passed to `consult--async-throttle'.
Other PROPS are passed to `make-process'."
  (declare (indent 1))
  (consult--async-pipeline
   (consult--async-options)
   (consult--async-min-input min-input)
   (consult--async-throttle throttle debounce)
   (apply #'consult--async-process builder
          (consult--plist-remove
           '(:min-input :throttle :debounce :transform :highlight) props))
   transform
   (and highlight (consult--async-highlight
                   (if (functionp highlight) highlight builder)))))