index.js (2346B)
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 ARCH 41 * @memberof ns 42 * @readonly 43 * @type {string} 44 * @see {@link module:@stdlib/os/arch} 45 */ 46 setReadOnly( ns, 'ARCH', require( './../arch' ) ); 47 48 /** 49 * @name BYTE_ORDER 50 * @memberof ns 51 * @readonly 52 * @type {string} 53 * @see {@link module:@stdlib/os/byte-order} 54 */ 55 setReadOnly( ns, 'BYTE_ORDER', require( './../byte-order' ) ); 56 57 /** 58 * @name configdir 59 * @memberof ns 60 * @readonly 61 * @type {Function} 62 * @see {@link module:@stdlib/os/configdir} 63 */ 64 setReadOnly( ns, 'configdir', require( './../configdir' ) ); 65 66 /** 67 * @name FLOAT_WORD_ORDER 68 * @memberof ns 69 * @readonly 70 * @type {string} 71 * @see {@link module:@stdlib/os/float-word-order} 72 */ 73 setReadOnly( ns, 'FLOAT_WORD_ORDER', require( './../float-word-order' ) ); 74 75 /** 76 * @name homedir 77 * @memberof ns 78 * @readonly 79 * @type {Function} 80 * @see {@link module:@stdlib/os/homedir} 81 */ 82 setReadOnly( ns, 'homedir', require( './../homedir' ) ); 83 84 /** 85 * @name NUM_CPUS 86 * @memberof ns 87 * @readonly 88 * @type {PositiveInteger} 89 * @see {@link module:@stdlib/os/num-cpus} 90 */ 91 setReadOnly( ns, 'NUM_CPUS', require( './../num-cpus' ) ); 92 93 /** 94 * @name PLATFORM 95 * @memberof ns 96 * @readonly 97 * @type {string} 98 * @see {@link module:@stdlib/os/platform} 99 */ 100 setReadOnly( ns, 'PLATFORM', require( './../platform' ) ); 101 102 /** 103 * @name tmpdir 104 * @memberof ns 105 * @readonly 106 * @type {Function} 107 * @see {@link module:@stdlib/os/tmpdir} 108 */ 109 setReadOnly( ns, 'tmpdir', require( './../tmpdir' ) ); 110 111 112 // EXPORTS // 113 114 module.exports = ns;