@stdlib/os-num-cpus

Number of CPUs.


Keywords
stdlib, stdutils, stdutil, utilities, utility, utils, util, cpus, cores, os, cpu, number, num, total, cluster, fork, process, cli, workers, concurrency, parallel, javascript, node, node-js, nodejs
License
Apache-2.0
Install
npm install @stdlib/os-num-cpus@0.0.7

Documentation

Number of CPUs

NPM version Build Status Coverage Status dependencies

Number of CPUs.

Installation

npm install @stdlib/os-num-cpus

Usage

var NUM_CPUS = require( '@stdlib/os-num-cpus' );

NUM_CPUS

Number of CPUs.

var n = NUM_CPUS;
// returns <number>

Notes

  • In a web browser, the number of CPUs is determined by querying the hardware concurrency API.
  • Otherwise, the number of CPUs is determined via the os module.

Examples

var proc = require( 'process' );
var cluster = require( 'cluster' );
var NUM_CPUS = require( '@stdlib/os-num-cpus' );

var i;

function onTimeout() {
    proc.exit( 0 );
}

if ( cluster.isMaster ) {
    for ( i = 0; i < NUM_CPUS; i++ ) {
        cluster.fork();
    }
} else {
    console.log( 'Worker %s. Process id: %d.', cluster.worker.id, cluster.worker.process.pid );

    setTimeout( onTimeout, 1000 );
}

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/os-num-cpus

Usage

Usage: num-cpus [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ num-cpus
<number>

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.