Skip to content

Commit 3d9e424

Browse files
committed
adding a type and more documentation
1 parent 15552b9 commit 3d9e424

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

index.ts

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,17 @@ export interface Options extends SpawnOptions{
3535
stderrParser?: (param:string)=>any
3636
encoding?: string
3737
pythonPath?: string
38+
/**
39+
* see https://docs.python.org/3.7/using/cmdline.html
40+
*/
3841
pythonOptions?: string[]
42+
/**
43+
* overrides scriptPath passed into PythonShell constructor
44+
*/
3945
scriptPath?: string
46+
/**
47+
* arguments to your program
48+
*/
4049
args?: string[]
4150
}
4251

@@ -97,7 +106,7 @@ export class PythonShell extends EventEmitter{
97106
EventEmitter.call(this);
98107

99108
options = <Options>extend({}, PythonShell.defaultOptions, options);
100-
let pythonPath;
109+
let pythonPath:string;
101110
if (!options.pythonPath) {
102111
pythonPath = PythonShell.defaultPythonPath;
103112
} else pythonPath = options.pythonPath;

0 commit comments

Comments
 (0)