num-cpus

1.1.0 • Public • Published

CPUs

NPM version Build Status Coverage Status Dependencies

Returns the number of CPUs.

Installation

$ npm install num-cpus

Usage

var numCPUs = require( 'num-cpus' );

numCPUs

The number of CPUs.

console.log( numCPUs );
// returns <number>

Examples

var cluster = require( 'cluster' ),
    numCPUs = require( 'num-cpus' );
 
var i;
 
function onTimeout() {
    process.exit( 0 );
}
 
if ( cluster.isMaster ) {
    for ( i = 0; i < numCPUs; i++ ) {
        cluster.fork();
    }
} else {
    console.log( 'Worker %s. Process id: %d.', cluster.worker.id, cluster.worker.process.pid );
 
    setTimeout( onTimeout, 1000 );
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

CLI

Installation

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

$ npm install -g num-cpus

Usage

Usage: numcpus [options]
 
Options:
 
  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ numcpus
# <number>

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.

Package Sidebar

Install

npm i num-cpus

Weekly Downloads

1,983

Version

1.1.0

License

MIT

Last publish

Collaborators

  • kgryte