diff --git a/doc/api/os.md b/doc/api/os.md index 2f71d10090ca85..279ed1f18ddc0f 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -26,6 +26,19 @@ The operating system-specific end-of-line marker. * `\n` on POSIX * `\r\n` on Windows +## `os.availableParallelism()` + + + +* Returns: {integer} + +Returns an estimate of the default amount of parallelism a program should use. +Always returns a value greater than zero. + +This function is a small wrapper about libuv's [`uv_available_parallelism()`][]. + ## `os.arch()`