Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/process-getgid

Return the numeric group identity of a calling process.
https://github.com/stdlib-js/process-getgid

darwin getegid getgid gid group id identity javascript linux node node-js nodejs posix process stdlib util utilities utility utils

Last synced: 13 days ago
JSON representation

Return the numeric group identity of a calling process.

Awesome Lists containing this project

README

        


About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

# getgid

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

> Return the numeric group identity of the calling process.

## Installation

```bash
npm install @stdlib/process-getgid
```

Alternatively,

- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

```javascript
var getgid = require( '@stdlib/process-getgid' );
```

#### getgid()

Returns the numeric group identity of the calling process.

```javascript
var id = getgid();
```

## Notes

- The function **only** returns an `integer` group identity on POSIX platforms. For all other platforms (e.g., Windows, browsers, and Android), the function returns `null`.
- See [getgid(2)][getgid].

## Examples

```javascript
var getgid = require( '@stdlib/process-getgid' );

var gid = getgid();
console.log( 'gid: %d', gid );
```

* * *

## See Also

- [`@stdlib/process-getegid`][@stdlib/process/getegid]: return the effective numeric group identity of a calling process.
- [`@stdlib/process-geteuid`][@stdlib/process/geteuid]: return the effective numeric user identity of a calling process.
- [`@stdlib/process-getuid`][@stdlib/process/getuid]: return the numeric user identity of a calling process.

* * *

## 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-2024. The Stdlib [Authors][stdlib-authors].

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

[test-image]: https://github.com/stdlib-js/process-getgid/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/process-getgid/actions/workflows/test.yml?query=branch:main

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

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

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

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

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/process-getgid/tree/deno
[deno-readme]: https://github.com/stdlib-js/process-getgid/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/process-getgid/tree/umd
[umd-readme]: https://github.com/stdlib-js/process-getgid/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/process-getgid/tree/esm
[esm-readme]: https://github.com/stdlib-js/process-getgid/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/process-getgid/blob/main/branches.md

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

[getgid]: http://man7.org/linux/man-pages/man2/getgid.2.html

[@stdlib/process/getegid]: https://github.com/stdlib-js/process-getegid

[@stdlib/process/geteuid]: https://github.com/stdlib-js/process-geteuid

[@stdlib/process/getuid]: https://github.com/stdlib-js/process-getuid