Skip to content

Commit f635ccd

Browse files
jaandrlejaandrle
committed
⚡ 📺 Maintenance update
- 🔤 fixes #45: removed - 📺 fixes #46: no need extra package - 📺 fixes #47: typedoc updated
1 parent 8073512 commit f635ccd

74 files changed

Lines changed: 605 additions & 612 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎bs/npm/install-audit‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env bash
2+
npx npq install "$1" --dry-run

‎bs/npm/lint‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env bash
2+
npx lockfile-lint --path package.json

‎bs/npm/update‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
#!/usr/bin/env bash
2+
npx npm-check-updates --interactive --format group --cooldown 7

‎docs/child_process/classes/ChildProcess.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ v0.1.90
116116

117117
### channel?
118118

119-
> `readonly` `optional` **channel**: [`Control`](../interfaces/Control.md)
119+
> `readonly` `optional` **channel?**: [`Control`](../interfaces/Control.md)
120120
121121
The `subprocess.channel` property is a reference to the child's IPC channel. If
122122
no IPC channel exists, this property is `undefined`.
@@ -188,7 +188,7 @@ v0.5.10
188188

189189
### pid?
190190

191-
> `readonly` `optional` **pid**: `number`
191+
> `readonly` `optional` **pid?**: `number`
192192
193193
Returns the process identifier (PID) of the child process. If the child process
194194
fails to spawn due to errors, then the value is `undefined` and `error` is
@@ -328,7 +328,7 @@ setTimeout(() => {
328328

329329
##### signal?
330330

331-
`number` | `Signals`
331+
`number` \| `Signals`
332332

333333
#### Returns
334334

@@ -1025,7 +1025,7 @@ Alias for `emitter.on(eventName, listener)`.
10251025

10261026
###### eventName
10271027

1028-
`string` | `symbol`
1028+
`string` \| `symbol`
10291029

10301030
###### listener
10311031

@@ -1165,7 +1165,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
11651165

11661166
###### eventName
11671167

1168-
`string` | `symbol`
1168+
`string` \| `symbol`
11691169

11701170
###### args
11711171

@@ -1239,9 +1239,9 @@ in the list of the listeners of the event.
12391239

12401240
###### eventName
12411241

1242-
The name of the event being listened for
1242+
`string` \| `symbol`
12431243

1244-
`string` | `symbol`
1244+
The name of the event being listened for
12451245

12461246
###### listener?
12471247

@@ -1321,7 +1321,7 @@ console.log(util.inspect(server.listeners('connection')));
13211321

13221322
###### eventName
13231323

1324-
`string` | `symbol`
1324+
`string` \| `symbol`
13251325

13261326
##### Returns
13271327

@@ -1383,7 +1383,7 @@ Alias for `emitter.removeListener()`.
13831383

13841384
###### eventName
13851385

1386-
`string` | `symbol`
1386+
`string` \| `symbol`
13871387

13881388
###### listener
13891389

@@ -1507,9 +1507,9 @@ myEE.emit('foo');
15071507

15081508
###### eventName
15091509

1510-
The name of the event.
1510+
`string` \| `symbol`
15111511

1512-
`string` | `symbol`
1512+
The name of the event.
15131513

15141514
###### listener
15151515

@@ -1629,9 +1629,9 @@ myEE.emit('foo');
16291629

16301630
###### eventName
16311631

1632-
The name of the event.
1632+
`string` \| `symbol`
16331633

1634-
`string` | `symbol`
1634+
The name of the event.
16351635

16361636
###### listener
16371637

@@ -1727,9 +1727,9 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
17271727

17281728
###### eventName
17291729

1730-
The name of the event.
1730+
`string` \| `symbol`
17311731

1732-
`string` | `symbol`
1732+
The name of the event.
17331733

17341734
###### listener
17351735

@@ -1821,9 +1821,9 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
18211821

18221822
###### eventName
18231823

1824-
The name of the event.
1824+
`string` \| `symbol`
18251825

1826-
`string` | `symbol`
1826+
The name of the event.
18271827

18281828
###### listener
18291829

@@ -1939,7 +1939,7 @@ emitter.emit('log');
19391939

19401940
###### eventName
19411941

1942-
`string` | `symbol`
1942+
`string` \| `symbol`
19431943

19441944
##### Returns
19451945

@@ -2009,7 +2009,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
20092009

20102010
###### eventName?
20112011

2012-
`string` | `symbol`
2012+
`string` \| `symbol`
20132013

20142014
##### Returns
20152015

@@ -2235,7 +2235,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
22352235

22362236
###### eventName
22372237

2238-
`string` | `symbol`
2238+
`string` \| `symbol`
22392239

22402240
###### listener
22412241

@@ -2381,7 +2381,7 @@ class MyClass extends EventEmitter {
23812381

23822382
##### event
23832383

2384-
`string` | `symbol`
2384+
`string` \| `symbol`
23852385

23862386
##### args
23872387

‎docs/child_process/functions/fork.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ if (process.argv[2] === 'child') {
5959

6060
#### modulePath
6161

62-
The module to run in the child.
62+
`string` \| `URL`
6363

64-
`string` | `URL`
64+
The module to run in the child.
6565

6666
#### options?
6767

@@ -128,9 +128,9 @@ if (process.argv[2] === 'child') {
128128

129129
#### modulePath
130130

131-
The module to run in the child.
131+
`string` \| `URL`
132132

133-
`string` | `URL`
133+
The module to run in the child.
134134

135135
#### args?
136136

‎docs/child_process/interfaces/ChildProcessByStdio.md‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ v0.7.10
172172

173173
### channel?
174174

175-
> `readonly` `optional` **channel**: [`Control`](Control.md)
175+
> `readonly` `optional` **channel?**: [`Control`](Control.md)
176176
177177
The `subprocess.channel` property is a reference to the child's IPC channel. If
178178
no IPC channel exists, this property is `undefined`.
@@ -207,7 +207,7 @@ v0.5.10
207207

208208
### pid?
209209

210-
> `readonly` `optional` **pid**: `number`
210+
> `readonly` `optional` **pid?**: `number`
211211
212212
Returns the process identifier (PID) of the child process. If the child process
213213
fails to spawn due to errors, then the value is `undefined` and `error` is
@@ -371,7 +371,7 @@ setTimeout(() => {
371371

372372
##### signal?
373373

374-
`number` | `Signals`
374+
`number` \| `Signals`
375375

376376
#### Returns
377377

@@ -1100,7 +1100,7 @@ Alias for `emitter.on(eventName, listener)`.
11001100

11011101
###### eventName
11021102

1103-
`string` | `symbol`
1103+
`string` \| `symbol`
11041104

11051105
###### listener
11061106

@@ -1240,7 +1240,7 @@ myEmitter.emit('event', 1, 2, 3, 4, 5);
12401240

12411241
###### eventName
12421242

1243-
`string` | `symbol`
1243+
`string` \| `symbol`
12441244

12451245
###### args
12461246

@@ -1314,9 +1314,9 @@ in the list of the listeners of the event.
13141314

13151315
###### eventName
13161316

1317-
The name of the event being listened for
1317+
`string` \| `symbol`
13181318

1319-
`string` | `symbol`
1319+
The name of the event being listened for
13201320

13211321
###### listener?
13221322

@@ -1396,7 +1396,7 @@ console.log(util.inspect(server.listeners('connection')));
13961396

13971397
###### eventName
13981398

1399-
`string` | `symbol`
1399+
`string` \| `symbol`
14001400

14011401
##### Returns
14021402

@@ -1458,7 +1458,7 @@ Alias for `emitter.removeListener()`.
14581458

14591459
###### eventName
14601460

1461-
`string` | `symbol`
1461+
`string` \| `symbol`
14621462

14631463
###### listener
14641464

@@ -1582,9 +1582,9 @@ myEE.emit('foo');
15821582

15831583
###### eventName
15841584

1585-
The name of the event.
1585+
`string` \| `symbol`
15861586

1587-
`string` | `symbol`
1587+
The name of the event.
15881588

15891589
###### listener
15901590

@@ -1704,9 +1704,9 @@ myEE.emit('foo');
17041704

17051705
###### eventName
17061706

1707-
The name of the event.
1707+
`string` \| `symbol`
17081708

1709-
`string` | `symbol`
1709+
The name of the event.
17101710

17111711
###### listener
17121712

@@ -1802,9 +1802,9 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
18021802

18031803
###### eventName
18041804

1805-
The name of the event.
1805+
`string` \| `symbol`
18061806

1807-
`string` | `symbol`
1807+
The name of the event.
18081808

18091809
###### listener
18101810

@@ -1896,9 +1896,9 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
18961896

18971897
###### eventName
18981898

1899-
The name of the event.
1899+
`string` \| `symbol`
19001900

1901-
`string` | `symbol`
1901+
The name of the event.
19021902

19031903
###### listener
19041904

@@ -2014,7 +2014,7 @@ emitter.emit('log');
20142014

20152015
###### eventName
20162016

2017-
`string` | `symbol`
2017+
`string` \| `symbol`
20182018

20192019
##### Returns
20202020

@@ -2084,7 +2084,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
20842084

20852085
###### eventName?
20862086

2087-
`string` | `symbol`
2087+
`string` \| `symbol`
20882088

20892089
##### Returns
20902090

@@ -2310,7 +2310,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
23102310

23112311
###### eventName
23122312

2313-
`string` | `symbol`
2313+
`string` \| `symbol`
23142314

23152315
###### listener
23162316

@@ -2456,7 +2456,7 @@ class MyClass extends EventEmitter {
24562456

24572457
##### event
24582458

2459-
`string` | `symbol`
2459+
`string` \| `symbol`
24602460

24612461
##### args
24622462

0 commit comments

Comments
 (0)