zx/index.d.ts

A tool for writing better scripts

// Copyright 2021 Google LLC
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     https://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

interface $ {
  (pieces: TemplateStringsArray, ...args: string[]): Promise<ProcessOutput>
  verbose: boolean
  shell: string
  cwd: string
  prefix: string
  quote: (input: string) => string
}

export const $: $

export function cd(path: string)

type QuestionOptions = { choices: string[] }

export function sleep(ms: number): Promise<void>

export function question(query?: string, options?: QuestionOptions): Promise<string>

export class ProcessOutput {
  readonly exitCode: number
  readonly stdout: string
  readonly stderr: string
  toString(): string
}