186 lines
6.6 KiB
Markdown
186 lines
6.6 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Process
|
||
|
|
|
||
|
|
[![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 process utilities.
|
||
|
|
|
||
|
|
<section class="installation">
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install @stdlib/process
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var ns = require( '@stdlib/process' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### ns
|
||
|
|
|
||
|
|
Standard library process utilities.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var proc = ns;
|
||
|
|
// returns {...}
|
||
|
|
```
|
||
|
|
|
||
|
|
The namespace contains process utilities:
|
||
|
|
|
||
|
|
<!-- <toc pattern="*"> -->
|
||
|
|
|
||
|
|
<div class="namespace-toc">
|
||
|
|
|
||
|
|
- <span class="signature">[`ARGV`][@stdlib/process/argv]</span><span class="delimiter">: </span><span class="description">array containing command-line arguments passed when launching the calling process.</span>
|
||
|
|
- <span class="signature">[`chdir( path )`][@stdlib/process/chdir]</span><span class="delimiter">: </span><span class="description">change the current working directory.</span>
|
||
|
|
- <span class="signature">[`cwd()`][@stdlib/process/cwd]</span><span class="delimiter">: </span><span class="description">return the current working directory.</span>
|
||
|
|
- <span class="signature">[`ENV`][@stdlib/process/env]</span><span class="delimiter">: </span><span class="description">object containing the user environment.</span>
|
||
|
|
- <span class="signature">[`EXEC_PATH`][@stdlib/process/exec-path]</span><span class="delimiter">: </span><span class="description">absolute pathname of the executable which started the current Node.js process.</span>
|
||
|
|
- <span class="signature">[`getegid()`][@stdlib/process/getegid]</span><span class="delimiter">: </span><span class="description">return the effective numeric group identity of the calling process.</span>
|
||
|
|
- <span class="signature">[`geteuid()`][@stdlib/process/geteuid]</span><span class="delimiter">: </span><span class="description">return the effective numeric user identity of the calling process.</span>
|
||
|
|
- <span class="signature">[`getgid()`][@stdlib/process/getgid]</span><span class="delimiter">: </span><span class="description">return the numeric group identity of the calling process.</span>
|
||
|
|
- <span class="signature">[`getuid()`][@stdlib/process/getuid]</span><span class="delimiter">: </span><span class="description">return the numeric user identity of the calling process.</span>
|
||
|
|
- <span class="signature">[`NODE_VERSION`][@stdlib/process/node-version]</span><span class="delimiter">: </span><span class="description">node version.</span>
|
||
|
|
- <span class="signature">[`stdin( [encoding,] clbk )`][@stdlib/process/read-stdin]</span><span class="delimiter">: </span><span class="description">read data from `stdin`.</span>
|
||
|
|
- <span class="signature">[`umask( [mask,] [options] )`][@stdlib/process/umask]</span><span class="delimiter">: </span><span class="description">get/set the process mask.</span>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- </toc> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- TODO: better examples -->
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var objectKeys = require( '@stdlib/utils/keys' );
|
||
|
|
var ns = require( '@stdlib/process' );
|
||
|
|
|
||
|
|
console.log( objectKeys( ns ) );
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
|
||
|
|
<section class="main-repo" >
|
||
|
|
|
||
|
|
* * *
|
||
|
|
|
||
|
|
## 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].
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.stdlib -->
|
||
|
|
|
||
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/process.svg
|
||
|
|
[npm-url]: https://npmjs.org/package/@stdlib/process
|
||
|
|
|
||
|
|
[test-image]: https://github.com/stdlib-js/process/actions/workflows/test.yml/badge.svg
|
||
|
|
[test-url]: https://github.com/stdlib-js/process/actions/workflows/test.yml
|
||
|
|
|
||
|
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/process/main.svg
|
||
|
|
[coverage-url]: https://codecov.io/github/stdlib-js/process?branch=main
|
||
|
|
|
||
|
|
[dependencies-image]: https://img.shields.io/david/stdlib-js/process.svg
|
||
|
|
[dependencies-url]: https://david-dm.org/stdlib-js/process/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/process/main/LICENSE
|
||
|
|
|
||
|
|
<!-- <toc-links> -->
|
||
|
|
|
||
|
|
[@stdlib/process/argv]: https://www.npmjs.com/package/@stdlib/process/tree/main/argv
|
||
|
|
|
||
|
|
[@stdlib/process/chdir]: https://www.npmjs.com/package/@stdlib/process/tree/main/chdir
|
||
|
|
|
||
|
|
[@stdlib/process/cwd]: https://www.npmjs.com/package/@stdlib/process/tree/main/cwd
|
||
|
|
|
||
|
|
[@stdlib/process/env]: https://www.npmjs.com/package/@stdlib/process/tree/main/env
|
||
|
|
|
||
|
|
[@stdlib/process/exec-path]: https://www.npmjs.com/package/@stdlib/process/tree/main/exec-path
|
||
|
|
|
||
|
|
[@stdlib/process/getegid]: https://www.npmjs.com/package/@stdlib/process/tree/main/getegid
|
||
|
|
|
||
|
|
[@stdlib/process/geteuid]: https://www.npmjs.com/package/@stdlib/process/tree/main/geteuid
|
||
|
|
|
||
|
|
[@stdlib/process/getgid]: https://www.npmjs.com/package/@stdlib/process/tree/main/getgid
|
||
|
|
|
||
|
|
[@stdlib/process/getuid]: https://www.npmjs.com/package/@stdlib/process/tree/main/getuid
|
||
|
|
|
||
|
|
[@stdlib/process/node-version]: https://www.npmjs.com/package/@stdlib/process/tree/main/node-version
|
||
|
|
|
||
|
|
[@stdlib/process/read-stdin]: https://www.npmjs.com/package/@stdlib/process/tree/main/read-stdin
|
||
|
|
|
||
|
|
[@stdlib/process/umask]: https://www.npmjs.com/package/@stdlib/process/tree/main/umask
|
||
|
|
|
||
|
|
<!-- </toc-links> -->
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|