README.md (1627B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # geteuid 22 23 > Return the effective numeric user identity of the calling process. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var geteuid = require( '@stdlib/process/geteuid' ); 31 ``` 32 33 #### geteuid() 34 35 Returns the effective numeric user identity of the calling process. 36 37 ```javascript 38 var id = geteuid(); 39 ``` 40 41 </section> 42 43 <!-- /.usage --> 44 45 <section class="notes"> 46 47 ## Notes 48 49 - The function **only** returns an `integer` user identity on POSIX platforms. For all other platforms (e.g., Windows, browsers, and Android), the function returns `null`. 50 - See [geteuid(2)][geteuid]. 51 52 </section> 53 54 <section class="examples"> 55 56 ## Examples 57 58 <!-- eslint no-undef: "error" --> 59 60 ```javascript 61 var geteuid = require( '@stdlib/process/geteuid' ); 62 63 var uid = geteuid(); 64 if ( uid === 0 ) { 65 console.log( 'Effectively running as root.' ); 66 } else { 67 console.log( 'uid: %d', uid ); 68 } 69 ``` 70 71 </section> 72 73 <!-- /.examples --> 74 75 <section class="links"> 76 77 [geteuid]: http://man7.org/linux/man-pages/man2/geteuid.2.html 78 79 </section> 80 81 <!-- /.links -->