5.5 KiB
5.5 KiB
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.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 ) );
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.
Copyright
Copyright © 2016-2021. The Stdlib Authors.