Skip to content

Commit

Permalink
2018-16-20, Version 10.5.0 (Current)
Browse files Browse the repository at this point in the history
Notable changes:

* **crypto**:
  * Support for `crypto.scrypt()` has been added.
    [#20816](#20816)
* **fs**:
  * BigInt support has been added to `fs.stat` and `fs.watchFile`.
    [#20220](#20220)
  * APIs that take `mode` as arguments no longer throw on values larger
    than `0o777`. [#20636](#20636)
    [#20975](#20975)
    (Fixes: [#20498](#20498))
  * Fix crashes in closed event watchers.
    [#20985](#20985)
    (Fixes: [#20297](#20297))
* **Worker Threads**:
  * Support for multi-threading has been added behind the
    `--experimental-worker` flag in the `worker_threads` module.
    This feature is *experimental* and may receive breaking changes at
    any time. [#20876](#20876)

PR-URL: #21400
  • Loading branch information
targos committed Jun 20, 2018
1 parent bc20ec0 commit e1c28f4
Show file tree
Hide file tree
Showing 6 changed files with 222 additions and 51 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ release.
</tr>
<tr>
<td valign="top">
<b><a href="doc/changelogs/CHANGELOG_V10.md#10.4.1">10.4.1</a></b><br/>
<b><a href="doc/changelogs/CHANGELOG_V10.md#10.5.0">10.5.0</a></b><br/>
<a href="doc/changelogs/CHANGELOG_V10.md#10.4.1">10.4.1</a><br/>
<a href="doc/changelogs/CHANGELOG_V10.md#10.4.0">10.4.0</a><br/>
<a href="doc/changelogs/CHANGELOG_V10.md#10.3.0">10.3.0</a><br/>
<a href="doc/changelogs/CHANGELOG_V10.md#10.2.1">10.2.1</a><br/>
Expand Down
4 changes: 2 additions & 2 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -2138,7 +2138,7 @@ request.

### crypto.scrypt(password, salt, keylen[, options], callback)
<!-- YAML
added: REPLACEME
added: v10.5.0
-->
- `password` {string|Buffer|TypedArray}
- `salt` {string|Buffer|TypedArray}
Expand Down Expand Up @@ -2184,7 +2184,7 @@ crypto.scrypt('secret', 'salt', 64, { N: 1024 }, (err, derivedKey) => {

### crypto.scryptSync(password, salt, keylen[, options])
<!-- YAML
added: REPLACEME
added: v10.5.0
-->
- `password` {string|Buffer|TypedArray}
- `salt` {string|Buffer|TypedArray}
Expand Down
36 changes: 18 additions & 18 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1681,8 +1681,8 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand All @@ -1703,8 +1703,8 @@ except that the file to be stat-ed is specified by the file descriptor `fd`.
<!-- YAML
added: v0.1.95
changes:
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down Expand Up @@ -1994,8 +1994,8 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand All @@ -2021,8 +2021,8 @@ changes:
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
protocol. Support is currently still *experimental*.
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down Expand Up @@ -2764,8 +2764,8 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down Expand Up @@ -2799,8 +2799,8 @@ changes:
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
protocol. Support is currently still *experimental*.
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down Expand Up @@ -3589,8 +3589,8 @@ The `FileHandle` has to support reading.
<!-- YAML
added: v10.0.0
changes:
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down Expand Up @@ -3925,8 +3925,8 @@ Asynchronous link(2). The `Promise` is resolved with no arguments upon success.
<!-- YAML
added: v10.0.0
changes:
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down Expand Up @@ -4119,8 +4119,8 @@ error on POSIX.
<!-- YAML
added: v10.0.0
changes:
- version: REPLACEME
pr-url: REPLACEME
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->
Expand Down
54 changes: 27 additions & 27 deletions doc/api/worker_threads.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Worker Threads

<!--introduced_in=REPLACEME-->
<!--introduced_in=v10.5.0-->

> Stability: 1 - Experimental
Expand Down Expand Up @@ -55,7 +55,7 @@ benefit of handing the work off to it.

## worker.isMainThread
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {boolean}
Expand All @@ -64,7 +64,7 @@ Is `true` if this code is not running inside of a [`Worker`][] thread.

## worker.parentPort
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {null|MessagePort}
Expand All @@ -78,7 +78,7 @@ using `worker.postMessage()` will be available in this thread using

## worker.threadId
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {integer}
Expand All @@ -88,15 +88,15 @@ An integer identifier for the current thread. On the corresponding worker object

## worker.workerData
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

An arbitrary JavaScript value that contains a clone of the data passed
to this thread’s `Worker` constructor.

## Class: MessageChannel
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Instances of the `worker.MessageChannel` class represent an asynchronous,
Expand All @@ -116,7 +116,7 @@ port2.postMessage({ foo: 'bar' });

## Class: MessagePort
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* Extends: {EventEmitter}
Expand All @@ -131,15 +131,15 @@ than `EventTarget`s, this implementation matches [browser `MessagePort`][]s.

### Event: 'close'
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

The `'close'` event is emitted once either side of the channel has been
disconnected.

### Event: 'message'
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `value` {any} The transmitted value
Expand All @@ -152,7 +152,7 @@ to `postMessage()` and no further arguments.

### port.close()
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Disables further sending of messages on either side of the connection.
Expand All @@ -161,7 +161,7 @@ will happen over this `MessagePort`.

### port.postMessage(value[, transferList])
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `value` {any}
Expand Down Expand Up @@ -198,7 +198,7 @@ behind this API, see the [serialization API of the `v8` module][v8.serdes].

### port.ref()
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Opposite of `unref()`. Calling `ref()` on a previously `unref()`ed port will
Expand All @@ -211,7 +211,7 @@ listeners for the event exist.

### port.start()
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Starts receiving messages on this `MessagePort`. When using this port
Expand All @@ -220,7 +220,7 @@ listeners are attached.

### port.unref()
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Calling `unref()` on a port will allow the thread to exit if this is the only
Expand All @@ -233,7 +233,7 @@ listeners for the event exist.

## Class: Worker
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

The `Worker` class represents an independent JavaScript execution thread.
Expand Down Expand Up @@ -327,7 +327,7 @@ if (isMainThread) {

### Event: 'error'
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `err` {Error}
Expand All @@ -337,7 +337,7 @@ exception. In that case, the worker will be terminated.

### Event: 'exit'
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `exitCode` {integer}
Expand All @@ -349,7 +349,7 @@ be `1`.

### Event: 'message'
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `value` {any} The transmitted value
Expand All @@ -360,15 +360,15 @@ event for more details.

### Event: 'online'
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

The `'online'` event is emitted when the worker thread has started executing
JavaScript code.

### worker.postMessage(value[, transferList])
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `value` {any}
Expand All @@ -380,7 +380,7 @@ See [`port.postMessage()`][] for more details.

### worker.ref()
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Opposite of `unref()`, calling `ref()` on a previously `unref()`ed worker will
Expand All @@ -390,7 +390,7 @@ no effect.

### worker.stderr
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {stream.Readable}
Expand All @@ -402,7 +402,7 @@ inside the worker thread. If `stderr: true` was not passed to the

### worker.stdin
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {null|stream.Writable}
Expand All @@ -413,7 +413,7 @@ the worker thread as [`process.stdin`][].

### worker.stdout
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {stream.Readable}
Expand All @@ -425,7 +425,7 @@ inside the worker thread. If `stdout: true` was not passed to the

### worker.terminate([callback])
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* `callback` {Function}
Expand All @@ -442,7 +442,7 @@ than what is exposed in the `worker` module.

### worker.threadId
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

* {integer}
Expand All @@ -452,7 +452,7 @@ it is available as [`require('worker_threads').threadId`][].

### worker.unref()
<!-- YAML
added: REPLACEME
added: v10.5.0
-->

Calling `unref()` on a worker will allow the thread to exit if this is the only
Expand Down
Loading

0 comments on commit e1c28f4

Please sign in to comment.