Skip to content

Commit a531e13

Browse files
PlaneshifterPlaneshifter
committed
Update namespace Typescript definitions
1 parent de6839a commit a531e13

8 files changed

Lines changed: 154 additions & 154 deletions

File tree

‎lib/node_modules/@stdlib/os/docs/types/index.d.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ import tmpdir = require( '@stdlib/os/tmpdir' );
3333
/**
3434
* Interface describing the `os` namespace.
3535
*/
36-
interface OS {
36+
interface Namespace {
3737
/**
3838
* Operating system CPU architecture.
3939
*
@@ -54,7 +54,7 @@ interface OS {
5454
* - x64
5555
*
5656
* @example
57-
* if ( os.ARCH === 'arm' || os.ARCH === 'arm64' ) {
57+
* if ( ns.ARCH === 'arm' || ns.ARCH === 'arm64' ) {
5858
* console.log( 'Running on ARM...' );
5959
* } else {
6060
* console.log( 'Running on something else...' );
@@ -75,9 +75,9 @@ interface OS {
7575
* - `'unknown'`
7676
*
7777
* @example
78-
* if ( os.BYTE_ORDER === 'little-endian' ) {
78+
* if ( ns.BYTE_ORDER === 'little-endian' ) {
7979
* console.log( 'Least significant byte comes first...' );
80-
* } else if ( os.BYTE_ORDER === 'big-endian' ) {
80+
* } else if ( ns.BYTE_ORDER === 'big-endian' ) {
8181
* console.log( 'Most significant byte comes first...' );
8282
* } else {
8383
* console.log( 'This is uncommon...' );
@@ -97,11 +97,11 @@ interface OS {
9797
* @returns directory
9898
*
9999
* @example
100-
* var dir = os.configdir();
100+
* var dir = ns.configdir();
101101
* // e.g., returns '/Users/<username>/Library/Preferences'
102102
*
103103
* @example
104-
* var dir = os.configdir( 'appname/config' );
104+
* var dir = ns.configdir( 'appname/config' );
105105
* // e.g., returns '/Users/<username>/Library/Preferences/appname/config'
106106
*/
107107
configdir: typeof configdir;
@@ -118,9 +118,9 @@ interface OS {
118118
* - `'unknown'`
119119
*
120120
* @example
121-
* if ( os.FLOAT_WORD_ORDER === 'little-endian' ) {
121+
* if ( ns.FLOAT_WORD_ORDER === 'little-endian' ) {
122122
* console.log( 'Least significant word comes first...' );
123-
* } else if ( os.FLOAT_WORD_ORDER === 'big-endian' ) {
123+
* } else if ( ns.FLOAT_WORD_ORDER === 'big-endian' ) {
124124
* console.log( 'Most significant word comes first...' );
125125
* } else {
126126
* console.log( 'Unknown...' );
@@ -138,7 +138,7 @@ interface OS {
138138
* @returns home directory
139139
*
140140
* @example
141-
* var home = os.homedir();
141+
* var home = ns.homedir();
142142
* // e.g., returns '/Users/<username>'
143143
*/
144144
homedir: typeof homedir;
@@ -152,7 +152,7 @@ interface OS {
152152
* - In Node.js environments, the number of CPUs is determined via the `os` module.
153153
*
154154
* @example
155-
* var num = os.NUM_CPUS;
155+
* var num = ns.NUM_CPUS;
156156
* // returns <number>
157157
*/
158158
NUM_CPUS: typeof NUM_CPUS;
@@ -171,9 +171,9 @@ interface OS {
171171
* - `'sunos'`
172172
*
173173
* @example
174-
* if ( os.PLATFORM === 'win32' ) {
174+
* if ( ns.PLATFORM === 'win32' ) {
175175
* console.log( 'Running on a PC...' );
176-
* } else if ( os.PLATFORM === 'darwin' ) {
176+
* } else if ( ns.PLATFORM === 'darwin' ) {
177177
* console.log( 'Running on a Mac...' );
178178
* } else {
179179
* console.log( 'Running on something else...' );
@@ -187,7 +187,7 @@ interface OS {
187187
* @returns directory for temporary files
188188
*
189189
* @example
190-
* var dir = os.tmpdir();
190+
* var dir = ns.tmpdir();
191191
* // e.g., returns '/path/to/temporary/files/directory'
192192
*/
193193
tmpdir: typeof tmpdir;
@@ -196,9 +196,9 @@ interface OS {
196196
/**
197197
* Standard library OS utilities.
198198
*/
199-
declare var os: OS;
199+
declare var ns: Namespace;
200200

201201

202202
// EXPORTS //
203203

204-
export = os;
204+
export = ns;

‎lib/node_modules/@stdlib/os/docs/types/test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ import os = require( './index' );
2525

2626
// The exported value is the expected interface...
2727
{
28-
os; // $ExpectType OS
28+
os; // $ExpectType Namespace
2929
}

0 commit comments

Comments
 (0)