Home Original page

doc: graduate Symbol.dispose/asyncDispose from experimental · nodejs/node@510872a

10 files changed

lines changed

Original file line numberDiff line numberDiff line change

@@ -1764,10 +1764,12 @@ setTimeout(() => {

17641764

added:

17651765

- v20.5.0

17661766

- v18.18.0

1767+

changes:

1768+

- version: REPLACEME

1769+

pr-url: https://github.com/nodejs/node/pull/58467

1770+

description: No longer experimental.

17671771

-->

17681772
1769-

> Stability: 1 - Experimental

1770-
17711773

Calls [`subprocess.kill()`][] with `'SIGTERM'`.

17721774
17731775

### `subprocess.killed`

Original file line numberDiff line numberDiff line change

@@ -380,10 +380,12 @@ provided, it is added as a listener for the [`'close'`][] event.

380380

added:

381381

- v20.5.0

382382

- v18.18.0

383+

changes:

384+

- version: REPLACEME

385+

pr-url: https://github.com/nodejs/node/pull/58467

386+

description: No longer experimental.

383387

-->

384388
385-

> Stability: 1 - Experimental

386-
387389

Calls [`socket.close()`][] and returns a promise that fulfills when the

388390

socket has closed.

389391
Original file line numberDiff line numberDiff line change

@@ -859,10 +859,12 @@ the end of the file.

859859

added:

860860

- v20.4.0

861861

- v18.18.0

862+

changes:

863+

- version: REPLACEME

864+

pr-url: https://github.com/nodejs/node/pull/58467

865+

description: No longer experimental.

862866

-->

863867
864-

> Stability: 1 - Experimental

865-
866868

Calls `filehandle.close()` and returns a promise that fulfills when the

867869

filehandle is closed.

868870

@@ -6750,21 +6752,25 @@ included in the iteration results.

67506752
67516753

<!-- YAML

67526754

added: v24.1.0

6755+

changes:

6756+

- version: REPLACEME

6757+

pr-url: https://github.com/nodejs/node/pull/58467

6758+

description: No longer experimental.

67536759

-->

67546760
6755-

> Stability: 1 - Experimental

6756-
67576761

Calls `dir.close()` and returns a promise that fulfills when the

67586762

dir is closed.

67596763
6760-

#### `dir[Symbol.Dispose]()`

6764+

#### `dir[Symbol.dispose]()`

67616765
67626766

<!-- YAML

67636767

added: v24.1.0

6768+

changes:

6769+

- version: REPLACEME

6770+

pr-url: https://github.com/nodejs/node/pull/58467

6771+

description: No longer experimental.

67646772

-->

67656773
6766-

> Stability: 1 - Experimental

6767-
67686774

Calls `dir.closeSync()` and returns `undefined`.

67696775
67706776

### Class: `fs.Dirent`

Original file line numberDiff line numberDiff line change

@@ -1936,10 +1936,12 @@ affects new connections to the server, not any existing connections.

19361936
19371937

<!-- YAML

19381938

added: v20.4.0

1939+

changes:

1940+

- version: REPLACEME

1941+

pr-url: https://github.com/nodejs/node/pull/58467

1942+

description: No longer experimental.

19391943

-->

19401944
1941-

> Stability: 1 - Experimental

1942-
19431945

Calls [`server.close()`][] and returns a promise that fulfills when the

19441946

server has closed.

19451947
Original file line numberDiff line numberDiff line change

@@ -2421,10 +2421,12 @@ closed, although the server has already stopped allowing new sessions. See

24212421
24222422

<!-- YAML

24232423

added: v20.4.0

2424+

changes:

2425+

- version: REPLACEME

2426+

pr-url: https://github.com/nodejs/node/pull/58467

2427+

description: No longer experimental.

24242428

-->

24252429
2426-

> Stability: 1 - Experimental

2427-
24282430

Calls [`server.close()`][] and returns a promise that fulfills when the

24292431

server has closed.

24302432
Original file line numberDiff line numberDiff line change

@@ -137,10 +137,12 @@ See [`server.close()`][] in the `node:http` module.

137137
138138

<!-- YAML

139139

added: v20.4.0

140+

changes:

141+

- version: REPLACEME

142+

pr-url: https://github.com/nodejs/node/pull/58467

143+

description: No longer experimental.

140144

-->

141145
142-

> Stability: 1 - Experimental

143-
144146

Calls [`server.close()`][httpsServerClose] and returns a promise that

145147

fulfills when the server has closed.

146148
Original file line numberDiff line numberDiff line change

@@ -402,10 +402,12 @@ was not open when it was closed.

402402

added:

403403

- v20.5.0

404404

- v18.18.0

405+

changes:

406+

- version: REPLACEME

407+

pr-url: https://github.com/nodejs/node/pull/58467

408+

description: No longer experimental.

405409

-->

406410
407-

> Stability: 1 - Experimental

408-
409411

Calls [`server.close()`][] and returns a promise that fulfills when the

410412

server has closed.

411413
Original file line numberDiff line numberDiff line change

@@ -416,10 +416,12 @@ targetDb.applyChangeset(changeset);

416416

added:

417417

- v23.11.0

418418

- v22.15.0

419+

changes:

420+

- version: REPLACEME

421+

pr-url: https://github.com/nodejs/node/pull/58467

422+

description: No longer experimental.

419423

-->

420424
421-

> Stability: 1 - Experimental

422-
423425

Closes the database connection. If the database connection is already closed

424426

then this is a no-op.

425427
Original file line numberDiff line numberDiff line change

@@ -983,10 +983,12 @@ Getter for the property `objectMode` of a given `Writable` stream.

983983

added:

984984

- v22.4.0

985985

- v20.16.0

986+

changes:

987+

- version: REPLACEME

988+

pr-url: https://github.com/nodejs/node/pull/58467

989+

description: No longer experimental.

986990

-->

987991
988-

> Stability: 1 - Experimental

989-
990992

Calls [`writable.destroy()`][writable-destroy] with an `AbortError` and returns

991993

a promise that fulfills when the stream is finished.

992994

@@ -1996,10 +1998,12 @@ has less then 64 KiB of data because no `highWaterMark` option is provided to

19961998

added:

19971999

- v20.4.0

19982000

- v18.18.0

2001+

changes:

2002+

- version: REPLACEME

2003+

pr-url: https://github.com/nodejs/node/pull/58467

2004+

description: No longer experimental.

19992005

-->

20002006
2001-

> Stability: 1 - Experimental

2002-
20032007

Calls [`readable.destroy()`][readable-destroy] with an `AbortError` and returns

20042008

a promise that fulfills when the stream is finished.

20052009
Original file line numberDiff line numberDiff line change

@@ -69,10 +69,12 @@ invoked. Calling `immediate.unref()` multiple times will have no effect.

6969

added:

7070

- v20.5.0

7171

- v18.18.0

72+

changes:

73+

- version: REPLACEME

74+

pr-url: https://github.com/nodejs/node/pull/58467

75+

description: No longer experimental.

7276

-->

7377
74-

> Stability: 1 - Experimental

75-
7678

Cancels the immediate. This is similar to calling `clearImmediate()`.

7779
7880

## Class: `Timeout`

@@ -175,10 +177,12 @@ thread. This allows enhanced compatibility with browser

175177

added:

176178

- v20.5.0

177179

- v18.18.0

180+

changes:

181+

- version: REPLACEME

182+

pr-url: https://github.com/nodejs/node/pull/58467

183+

description: No longer experimental.

178184

-->

179185
180-

> Stability: 1 - Experimental

181-
182186

Cancels the timeout.

183187
184188

## Scheduling timers