Skip to content

Commit df51425

Browse files
authored
Add a dependency on Typedoc (#4)
1 parent f8d7ee0 commit df51425

File tree

4 files changed

+24
-6
lines changed

4 files changed

+24
-6
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ dist
44
node_modules
55
npm-debug.log*
66
package-lock.json
7+
/docs
8+
/spec
79

810
# Editors
911
.idea

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## 1.0.1
2+
3+
* No user-visible changes
4+
5+
## 1.0.0
6+
7+
* Initial release

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,24 @@
33
This package exposes a `SyncChildProcess` class that allows Node.js to run a
44
subprocess synchronously *and* interactively.
55

6+
[**API Docs**]
7+
8+
[**API Docs**]: https://sass.github.io/sync-child-process/classes/SyncChildProcess.html
9+
610
## Usage
711

8-
Use `new SyncChildProcess()` to start running a subprocess. This supports the
12+
Use [`new SyncChildProcess()`] to start running a subprocess. This supports the
913
same API as [`child_process.spawn()`] other than a few options. You can send
10-
input to the process using `process.stdin`, and receive events from it (stdout,
11-
stderr, or exit) using `process.next()`. This implements [the iterator
12-
protocol], but *not* the iterable protocol because it's intrinsically stateful.
14+
input to the process using [`process.stdin`], and receive events from it
15+
(stdout, stderr, or exit) using [`process.next()`]. This implements [the
16+
iterator protocol], but *not* the iterable protocol because it's intrinsically
17+
stateful.
1318

14-
[the iterator protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterator_protocol
19+
[`new SyncChildProcess()`]: https://sass.github.io/sync-child-process/classes/SyncChildProcess.html#constructor
1520
[`child_process.spawn()`]: https://nodejs.org/api/child_process.html#child_processspawncommand-args-options
21+
[`process.stdin`]: https://sass.github.io/sync-child-process/classes/SyncChildProcess.html#stdin
22+
[`process.next()`]: https://sass.github.io/sync-child-process/classes/SyncChildProcess.html#next
23+
[the iterator protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterator_protocol
1624

1725
```js
1826
import {SyncChildProcess} from 'sync-child-process';

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sync-child-process",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"description": "Run a subprocess synchronously and interactively in Node.js",
55
"repository": "sass/sync-child-process",
66
"author": "Google Inc.",
@@ -34,6 +34,7 @@
3434
"npm-run-all": "^4.1.5",
3535
"ts-jest": "^29.0.5",
3636
"ts-node": "^10.2.1",
37+
"typedoc": "^0.26.11",
3738
"typescript": "^5.0.2"
3839
},
3940
"dependencies": {

0 commit comments

Comments
 (0)