Package Exports

@stdlib/os
@stdlib/os/arch
@stdlib/os/byte-order
@stdlib/os/configdir
@stdlib/os/float-word-order
@stdlib/os/homedir
@stdlib/os/num-cpus
@stdlib/os/platform
@stdlib/os/tmpdir

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/os) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OS

Standard library OS utilities.

Installation

npm install @stdlib/os

Usage

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

ns

Standard library 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.
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 ) );

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

License

See LICENSE.

@stdlib/os