OS

OS utilities.

Usage

var ns = require( '@stdlib/os' );

ns

Namespace containing OS utilities.

var os = ns;
// returns {...}

The namespace contains a variety of OS-related utility methods:

  • configdir( [path] ): return a directory for user-specific configuration files.
  • homedir(): return the current user's home directory.
  • tmpdir(): return the directory for storing temporary files.

In addition, it exports the following constants:

  • ARCH: operating system CPU architecture for which the JavaScript runtime binary was compiled.
  • BYTE_ORDER: platform byte order.
  • FLOAT_WORD_ORDER: platform float word order.
  • NUM_CPUS: number of CPUs.
  • PLATFORM: platform on which the current process is running.

Examples

var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/os' );

console.log( objectKeys( ns ) );
Did you find this page helpful?