Skip to content

Commit 561b1d6

Browse files
authored
moving methods to proper place in readme
1 parent b686ee9 commit 561b1d6

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,21 @@ PythonShell.runString('x=1;print(x)', null, function (err, results) {
233233
});
234234
```
235235

236+
#### `#checkSyntax(code:string)`
237+
238+
Checks the syntax of the code and returns a promise.
239+
Promise is rejected if there is a syntax error.
240+
241+
#### `#checkSyntaxFile(filePath:string)`
242+
243+
Checks the syntax of the file and returns a promise.
244+
Promise is rejected if there is a syntax error.
245+
246+
#### `#getVersionSync(pythonPath?:string)`
247+
248+
Returns the python version. Optional pythonPath param to get the version
249+
of a specific python interpreter.
250+
236251
#### `.send(message)`
237252

238253
Sends a message to the Python script via stdin. The data is formatted according to the selected mode (text or JSON), or through a custom function when `formatter` is specified.
@@ -265,21 +280,6 @@ Closes the stdin stream, allowing the Python script to finish and exit. The opti
265280

266281
Terminates the python script, the optional end callback is invoked if specified. A kill signal may be provided by `signal`, if `signal` is not specified SIGTERM is sent.
267282

268-
#### `checkSyntax(code:string)`
269-
270-
Checks the syntax of the code and returns a promise.
271-
Promise is rejected if there is a syntax error.
272-
273-
#### `checkSyntaxFile(filePath:string)`
274-
275-
Checks the syntax of the file and returns a promise.
276-
Promise is rejected if there is a syntax error.
277-
278-
#### `getVersionSync(pythonPath?:string)`
279-
280-
Returns the python version. Optional pythonPath param to get the version
281-
of a specific python interpreter.
282-
283283
#### event: `message`
284284

285285
Fires when a chunk of data is parsed from the stdout stream via the `receive` method. If a `parser` method is specified, the result of this function will be the message value. This event is not emitted in binary mode.

0 commit comments

Comments
 (0)