API Reference

Namespaces

Modules

headlesscli

Classes

Events

Global

$$
$$$
CIQ_DRAWING_NAME
Discovery
Executor
LS_KEY
SUGGESTION_THRESHOLD
`ingestor` takes one or more `(s: string) => string` transform functions and returns an `ingest` function that you can call repeatedly with different inputs. Each transform is applied left‑to‑right, but the pipeline is defined once and executed many times. **Error handling** - If any transform throws, the error is recorded in a private, per‑pipeline error log and the value from the previous step is passed on unchanged. Execution continues through the remaining transforms. - After the entire pipeline finishes, `ingest` checks whether errors were recorded. If at least one transform failed, `ingest` throws an `Error`. The thrown error's `message` summarises the number of failures, but the complete error list is available on the `ingest` function itself via `getErrors()`. - The error log is reset at the beginning of every `ingest(input)` call, so you always see only the errors from the most recent invocation. **Returned `ingest` function** In addition to being callable, the returned `ingest` object exposes: - `ingest.getErrors()` → returns a shallow copy of the errors accumulated during the last call. Each error is an object with the shape `{ step: string, message: string, input: string }`. - `ingest.onError(handler)` → registers a callback that receives the same error object **immediately** when a transform fails, before the final throw. Useful for live logging or metrics. Returns `ingest` for chaining.
configOverwrites
configuration
createUniverseStore
express
isKeyDevGroup
levenshtein
registerFDC3
setConfigBasedUI
startActiveTrader
suggest

Externals

Namespace: whitespace

whitespace

Whitespace and line-ending transformations.

Members

collapseSpaces

Collapse spaces and tabs, while preserving newline boundaries.

Since:

10.5.0

collapseWhitespace

Collapse all whitespace (including newlines) into single spaces.

Since:

10.5.0

normalizeNewlines

Replace all newline variants with \n.

Since:

10.5.0

trimLines

Trim leading and trailing whitespace from every line.

Since:

10.5.0

unwrapLines

Merge multi-line commands by removing backslash-newline continuations.

Since:

10.5.0