# OS

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]

> Standard library OS utilities.

## Installation

```bash
npm install @stdlib/os
```


## Usage

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

#### ns

Standard library OS utilities.

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

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

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

In addition, it exports the following constants:

-   [`ARCH`][@stdlib/os/arch]: operating system CPU architecture.
-   [`BYTE_ORDER`][@stdlib/os/byte-order]: platform byte order.
-   [`FLOAT_WORD_ORDER`][@stdlib/os/float-word-order]: platform float word order.
-   [`NUM_CPUS`][@stdlib/os/num-cpus]: number of CPUs.
-   [`PLATFORM`][@stdlib/os/platform]: platform on which the current process is running.

## Examples

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

console.log( objectKeys( ns ) );
```


* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/os.svg
[npm-url]: https://npmjs.org/package/@stdlib/os

[test-image]: https://github.com/stdlib-js/os/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/os/actions/workflows/test.yml

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/os/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/os?branch=main

[dependencies-image]: https://img.shields.io/david/stdlib-js/os.svg
[dependencies-url]: https://david-dm.org/stdlib-js/os/main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/os/main/LICENSE

[@stdlib/os/arch]: https://github.com/stdlib-js/os/tree/main/arch

[@stdlib/os/byte-order]: https://github.com/stdlib-js/os/tree/main/byte-order

[@stdlib/os/float-word-order]: https://github.com/stdlib-js/os/tree/main/float-word-order

[@stdlib/os/num-cpus]: https://github.com/stdlib-js/os/tree/main/num-cpus

[@stdlib/os/platform]: https://github.com/stdlib-js/os/tree/main/platform

[@stdlib/os/configdir]: https://github.com/stdlib-js/os/tree/main/configdir

[@stdlib/os/homedir]: https://github.com/stdlib-js/os/tree/main/homedir

[@stdlib/os/tmpdir]: https://github.com/stdlib-js/os/tree/main/tmpdir

