Project cross-spawn-windows-exe

Index

Type aliases

Functions

Type aliases

CrossSpawnExeOptions

CrossSpawnExeOptions: CrossSpawnOptions & { wrapperCommand?: string; wrapperInstructions?: string }

An extension to CrossSpawnOptions to optionally specify a custom wrapper command and instructions to install the wrapper.

DetermineWrapperFunction

DetermineWrapperFunction: (customPath?: string) => string

A function which determines the wrapper path or binary to use in [[spawnWrapper]].

param: The path specified by CrossSpawnExeOptions.wrapperCommand, usually prioritized over other paths/binaries in the function.

Type declaration

- (customPath?: string): string
- Parameters
  - Optional customPath: string
  Returns string

Functions

canRunWindowsExeNatively

canRunWindowsExeNatively(): boolean

- Defined in wrapper.ts:11
Returns boolean

normalizePath

normalizePath(pathToNormalize: string): Promise<string>

- Defined in normalize-path.ts:29
Converts a UNIX-style path to a Windows-style path if run in a WSL environment.

Parameters
- pathToNormalize: string
Returns Promise<string>

spawn

spawn(cmd: string, args?: CrossSpawnArgs, options?: CrossSpawnExeOptions): Promise<string>

- Defined in wrapper.ts:80
A wrapper for cross-spawn's spawn function that wraps the cmd with wrapperCommand if it is specified.

Parameters
- cmd: string
- Optional args: CrossSpawnArgs
- Optional options: CrossSpawnExeOptions
Returns Promise<string>

spawnDotNet

spawnDotNet(cmd: string, args?: CrossSpawnArgs, options?: CrossSpawnExeOptions): Promise<string>

- Defined in dotnet.ts:29
Spawn a .NET executable. On non-Windows platforms, use Nono to run it.

Parameters
- cmd: string
- Optional args: CrossSpawnArgs
- Optional options: CrossSpawnExeOptions
Returns Promise<string>

spawnExe

spawnExe(cmd: string, args?: CrossSpawnArgs, options?: CrossSpawnExeOptions): Promise<string>

- Defined in exe.ts:50
Spawn a Windows executable. On non-Windows platforms, use Wine to run it.

Parameters
- cmd: string
- Optional args: CrossSpawnArgs
- Optional options: CrossSpawnExeOptions
Returns Promise<string>

spawnWrapperFromFunction

spawnWrapperFromFunction(wrapperFunction: DetermineWrapperFunction, cmd: string, args?: CrossSpawnArgs, options?: CrossSpawnExeOptions): Promise<string>

- Defined in wrapper.ts:107
A helper variant of [[spawnWrapper]] which uses a DetermineWrapperFunction to determine wrapperCommand.

Parameters
- wrapperFunction: DetermineWrapperFunction
- cmd: string
- Optional args: CrossSpawnArgs
- Optional options: CrossSpawnExeOptions
Returns Promise<string>

Generated using TypeDoc