add syncline.d.ts

Author: arcticnotes

lib/syncline.d.ts

@@ -0,0 +1,51 @@
+import EventEmitter from 'node:events';
+
+export type SynclineSpawnOptions = {
+
+	/**
+	 * Current working directory of the child process. Defaults to the CWD of the current process.
+	 */
+	cwd?: string,
+
+	/**
+	 * Environment variables. Defaults to the environment variables of the current process.
+	 */
+	env?: { [ key: string]: string},
+
+	/**
+	 * `argv[0]`, defaults to the command.
+	 */
+	argv0?: string
+}
+
+export class Syncline extends EventEmitter {
+
+	/**
+	 * Spawns a child process with the specified command name and arguments, and returns a {@link Promise} that resolves
+	 * to a {@link Syncline}.
+	 *
+	 * @param command Command name
+	 * @param args Arguments, defaults to empty array
+	 * @param options Spawn options
+	 */
+	static async spawn( command: string, args?: string[], options?: SynclineSpawnOptions): Promise< Syncline> {
+	}
+
+	/**
+	 * Sends a line of text to the child process and returns the next line from the child process.
+	 *
+	 * @param inputLine A line of input string
+	 * @param timeout Optional timeout in milliseconds
+	 */
+	exchange( inputLine: string, timeout?: number): string {
+	}
+
+	/**
+	 * Terminates the child process, if not already, and returns a {@link Promise} that resolves to one of the following:
+	 *
+	 * *  An object with property `code` set to the exit status code of the child process.
+	 * *  An object with property `signal` set to the signal that terminated the child process.
+	 */
+	async close(): Promise< { code: number} | { signal: string}> {
+	}
+}

lib/syncline.js

@@ -141,16 +141,6 @@ const EVENT_EXIT   = 'exit';
 
 export class Syncline extends EventEmitter {
 
-	/**
-	 * Spawns a child process with the specified command name and arguments, and returns a {@link Promise} that resolves
-	 * to a {@link Syncline}.
-	 *
-	 * @param { string} command Command name
-	 * @param { undefined | string[]} args Arguments, defaults to empty array
-	 * @param { undefined | { cwd?: string, env?: { [ key: string]: string}, argv0?: string}} options See the `spawn()`
-	 *    function from `child_process` Node.js module. Only `cwd`, `env`, and `argv0` are supported.
-	 * @returns { Promise< Syncline>}
-	 */
 	static async spawn( command, args = [], options = {}) {
 		// the initial feedback (whether the worker has successfully spawned the child process and whether it is ready to
 		// receive input) must be done through parentPort and not through SharedArrayBuffer+Atomics, because the main
@@ -258,14 +248,6 @@ export class Syncline extends EventEmitter {
 		}
 	}
 
-	/**
-	 * Terminates the child process, if not already, and returns a {@link Promise} that resolves to one of the following:
-	 *
-	 * *  An object with property `code` set to the exit status code of the child process.
-	 * *  An object with property `signal` set to the signal that terminated the child process.
-	 *
-	 * @returns { Promise< { code: number} | { signal: string}>}
-	 */
 	async close() {
 		if( this.#terminated)
 			return this.#terminated;

package.json

@@ -13,6 +13,7 @@
 		"url": "https://github.com/arcticnotes/syncline/issues"
 	},
 	"type": "module",
+	"types": "lib/syncline.d.ts",
 	"exports": {
 		".": "./lib/index.js"
 	}