Interface Options

index.ts:41–63

const execPromise = promisify(exec)

export interface Options extends SpawnOptions {
    /**
     * if binary is enabled message and stderr events will not be emitted
     */
    mode?: 'text' | 'json' | 'binary'
    formatter?: string | ((param: string) => any)
    parser?: string | ((param: string) => any)
    stderrParser?: string | ((param: string) => any)
    encoding?: BufferEncoding
    pythonPath?: string
    /**
     * see https://docs.python.org/3.7/using/cmdline.html
     */
    pythonOptions?: string[]
    /**
     * overrides scriptPath passed into PythonShell constructor
     */
    scriptPath?: string
    /**
     * arguments to your program
     */
    args?: string[]
}

export class PythonShellError extends Error {
    traceback: string | Buffer;