Command overview
Added in v1.0.0
Table of contents
combinators
env
Signature
export declare const env: {
(environment: Record<string, string>): (self: Command) => Command
(self: Command, environment: Record<string, string>): Command
}
Added in v1.0.0
feed
Signature
export declare const feed: { (input: string): (self: Command) => Command; (self: Command, input: string): Command }
Added in v1.0.0
flatten
Signature
export declare const flatten: (self: Command) => readonly [StandardCommand, ...StandardCommand[]]
Added in v1.0.0
pipeTo
Signature
export declare const pipeTo: { (into: Command): (self: Command) => Command; (self: Command, into: Command): Command }
Added in v1.0.0
runInShell
Signature
export declare const runInShell: {
(shell: string | boolean): (self: Command) => Command
(self: Command, shell: string | boolean): Command
}
Added in v1.0.0
stderr
Signature
export declare const stderr: {
(stderr: CommandOutput): (self: Command) => Command
(self: Command, stderr: CommandOutput): Command
}
Added in v1.0.0
stdin
Signature
export declare const stdin: {
(stdin: CommandInput): (self: Command) => Command
(self: Command, stdin: CommandInput): Command
}
Added in v1.0.0
stdout
Signature
export declare const stdout: {
(stdout: CommandOutput): (self: Command) => Command
(self: Command, stdout: CommandOutput): Command
}
Added in v1.0.0
workingDirectory
Signature
export declare const workingDirectory: {
(cwd: string): (self: Command) => Command
(self: Command, cwd: string): Command
}
Added in v1.0.0
constructors
make
Signature
export declare const make: (command: string, ...args: string[]) => Command
Added in v1.0.0
execution
exitCode
Signature
export declare const exitCode: (self: Command) => Effect<CommandExecutor, PlatformError, ExitCode>
Added in v1.0.0
lines
Signature
export declare const lines: (
command: Command,
encoding?: string | undefined
) => Effect<CommandExecutor, PlatformError, readonly string[]>
Added in v1.0.0
start
Signature
export declare const start: (command: Command) => Effect<Scope | CommandExecutor, PlatformError, Process>
Added in v1.0.0
stream
Signature
export declare const stream: (command: Command) => Stream<CommandExecutor, PlatformError, Uint8Array>
Added in v1.0.0
streamLines
Signature
export declare const streamLines: (command: Command) => Stream<CommandExecutor, PlatformError, string>
Added in v1.0.0
string
Signature
export declare const string: {
(encoding?: string | undefined): (command: Command) => Effect<CommandExecutor, PlatformError, string>
(command: Command, encoding?: string | undefined): Effect<CommandExecutor, PlatformError, string>
}
Added in v1.0.0
model
Command
Signature
export declare const Command: Command
Added in v1.0.0
CommandInput
Signature
export declare const CommandInput: CommandInput
Added in v1.0.0
CommandOutput
Signature
export declare const CommandOutput: CommandOutput
Added in v1.0.0
PipedCommand
Signature
export declare const PipedCommand: PipedCommand
Added in v1.0.0
StandardCommand
Signature
export declare const StandardCommand: StandardCommand
Added in v1.0.0
refinements
isCommand
Signature
export declare const isCommand: (u: unknown) => u is Command
Added in v1.0.0