stim 1.20.2 → 1.22.0

package/dist/exec-DnYc4HGH.d.mts

@@ -0,0 +1,78 @@
+import { StimContext } from "@stim-cli/core";
+import "@stim-cli/core/state";
+import { ChildProcess, SpawnOptions } from "child_process";
+//#region src/ndjson.d.ts
+interface NdjsonWriter {
+  readonly file: string;
+  write(record: unknown): boolean;
+  close(): {
+    file: string;
+    written: number;
+    dropped: number;
+    lastError: Error | null;
+  };
+  readonly written: number;
+  readonly dropped: number;
+  readonly lastError: Error | null;
+}
+declare function createNdjsonWriter(file: string, { truncate, fields, maxBytes, now }?: {
+  truncate?: boolean;
+  fields?: Record<string, unknown>;
+  maxBytes?: number;
+  now?: () => number;
+}): NdjsonWriter;
+//#endregion
+//#region src/exec.d.ts
+interface ExecOptions {
+  /** Milliseconds before the child is killed, or 'unbounded' for a call that may legitimately run as long as it needs, such as a native build. */
+  timeoutMs: number | "unbounded";
+  killSignal?: NodeJS.Signals;
+  /** runFileAsync only: cancellation for this child; overrides the current report signal for bounded cleanup. */
+  signal?: AbortSignal;
+  cwd?: string;
+  env?: Record<string, string>;
+  omitEnv?: readonly string[];
+  /** Text written to the child's stdin. */
+  input?: string;
+  /** `runFileAsync` only: called with the child right after it starts; a throw kills the child and rejects the call. */
+  onSpawn?: (child: ChildProcess) => void;
+  /** runFileAsync only: record this serialized child on the operation's active ownership claims. */
+  declareFor?: StimContext;
+  /** `runFile` and `runFileAsync`: return stdout as written, without trimming surrounding whitespace. */
+  untrimmed?: boolean;
+  /**
+   * `runFile` and `runFileAsync`: reject nonempty stderr even when the command exits successfully.
+   */
+  rejectStderr?: boolean;
+  /** `runFile` and `runFileAsync`: run in its own session with all stdio ignored and return ''; the child reports through a file, so a background process it leaves behind cannot hold a pipe open. */
+  detachedSilent?: boolean;
+  /** `runFileAsync` only: put the Windows child tree in a kill-on-close Job Object. */
+  containProcessTree?: boolean;
+  /** `runFileAsync` with a cancellation signal: begin verified tree cleanup at leader exit, before inherited pipes close. */
+  cleanupOnExit?: boolean;
+  /**
+   * Exact values replaced with `***` in every string field of a thrown error.
+   * Async calls that time out or overflow discard captured output when any nonempty redaction value is supplied.
+   */
+  redact?: readonly string[];
+}
+interface Executor {
+  run(cmd: string, opts: ExecOptions): string;
+  runFile(file: string, args: string[], opts: ExecOptions): string;
+  /** `runFile` without blocking the event loop; rejects where `runFile` throws. */
+  runFileAsync(file: string, args: string[], opts: ExecOptions): Promise<string>;
+  runQuiet(cmd: string, opts: ExecOptions): string | null;
+  runFileQuiet(file: string, args: string[], opts: ExecOptions): string | null;
+  /** `runFileQuiet` without blocking the event loop. */
+  runFileQuietAsync(file: string, args: string[], opts: ExecOptions): Promise<string | null>;
+  spawn(cmd: string, args?: readonly string[], opts?: SpawnOptions): ChildProcess;
+  /** The cancellation signal of the current bounded report, including while a child is queued. */
+  reportSignal?(): AbortSignal | undefined;
+  /** Absolute path of `name` on PATH, or null. Options override the operation's cwd/environment; Windows uses PATHEXT. */
+  findExecutable(name: string, options?: {
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+  }): string | null;
+}
+//#endregion
+export { NdjsonWriter as n, createNdjsonWriter as r, Executor as t };