index.js (2991B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /* 22 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. 23 */ 24 25 // MODULES // 26 27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); 28 29 30 // MAIN // 31 32 /** 33 * Top-level namespace. 34 * 35 * @namespace ns 36 */ 37 var ns = {}; 38 39 /** 40 * @name ARGV 41 * @memberof ns 42 * @readonly 43 * @type {Array} 44 * @see {@link module:@stdlib/process/argv} 45 */ 46 setReadOnly( ns, 'ARGV', require( './../argv' ) ); 47 48 /** 49 * @name chdir 50 * @memberof ns 51 * @readonly 52 * @type {Function} 53 * @see {@link module:@stdlib/process/chdir} 54 */ 55 setReadOnly( ns, 'chdir', require( './../chdir' ) ); 56 57 /** 58 * @name cwd 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/process/cwd} 63 */ 64 setReadOnly( ns, 'cwd', require( './../cwd' ) ); 65 66 /** 67 * @name ENV 68 * @memberof ns 69 * @readonly 70 * @type {Object} 71 * @see {@link module:@stdlib/process/env} 72 */ 73 setReadOnly( ns, 'ENV', require( './../env' ) ); 74 75 /** 76 * @name EXEC_PATH 77 * @memberof ns 78 * @readonly 79 * @type {string} 80 * @see {@link module:@stdlib/process/exec-path} 81 */ 82 setReadOnly( ns, 'EXEC_PATH', require( './../exec-path' ) ); 83 84 /** 85 * @name getegid 86 * @memberof ns 87 * @readonly 88 * @type {Function} 89 * @see {@link module:@stdlib/process/getegid} 90 */ 91 setReadOnly( ns, 'getegid', require( './../getegid' ) ); 92 93 /** 94 * @name geteuid 95 * @memberof ns 96 * @readonly 97 * @type {Function} 98 * @see {@link module:@stdlib/process/geteuid} 99 */ 100 setReadOnly( ns, 'geteuid', require( './../geteuid' ) ); 101 102 /** 103 * @name getgid 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/process/getgid} 108 */ 109 setReadOnly( ns, 'getgid', require( './../getgid' ) ); 110 111 /** 112 * @name getuid 113 * @memberof ns 114 * @readonly 115 * @type {Function} 116 * @see {@link module:@stdlib/process/getuid} 117 */ 118 setReadOnly( ns, 'getuid', require( './../getuid' ) ); 119 120 /** 121 * @name NODE_VERSION 122 * @memberof ns 123 * @readonly 124 * @type {(string|null)} 125 * @see {@link module:@stdlib/process/node-version} 126 */ 127 setReadOnly( ns, 'NODE_VERSION', require( './../node-version' ) ); 128 129 /** 130 * @name stdin 131 * @memberof ns 132 * @readonly 133 * @type {Function} 134 * @see {@link module:@stdlib/process/read-stdin} 135 */ 136 setReadOnly( ns, 'stdin', require( './../read-stdin' ) ); 137 138 /** 139 * @name umask 140 * @memberof ns 141 * @readonly 142 * @type {Function} 143 * @see {@link module:@stdlib/process/umask} 144 */ 145 setReadOnly( ns, 'umask', require( './../umask' ) ); 146 147 148 // EXPORTS // 149 150 module.exports = ns;