Skip to content

Commit 146fe41

Browse files
PlaneshifterPlaneshifter
committed
Update example code in namespace examples
1 parent 7a9fc35 commit 146fe41

11 files changed

Lines changed: 193 additions & 298 deletions

File tree

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

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818

1919
// TypeScript Version: 2.0
2020

21+
/* tslint:disable:max-line-length */
22+
/* tslint:disable:max-file-line-count */
23+
2124
import HOURS_IN_DAY = require( '@stdlib/constants/time/hours-in-day' );
2225
import HOURS_IN_WEEK = require( '@stdlib/constants/time/hours-in-week' );
2326
import MILLISECONDS_IN_DAY = require( '@stdlib/constants/time/milliseconds-in-day' );
@@ -42,7 +45,7 @@ interface TIME {
4245
* Number of hours in a day.
4346
*
4447
* @example
45-
* var num = HOURS_IN_DAY;
48+
* var num = time.HOURS_IN_DAY;
4649
* // returns 24
4750
*/
4851
HOURS_IN_DAY: typeof HOURS_IN_DAY;
@@ -51,7 +54,7 @@ interface TIME {
5154
* Number of hours in a week.
5255
*
5356
* @example
54-
* var num = HOURS_IN_WEEK;
57+
* var num = time.HOURS_IN_WEEK;
5558
* // returns 168
5659
*/
5760
HOURS_IN_WEEK: typeof HOURS_IN_WEEK;
@@ -60,7 +63,7 @@ interface TIME {
6063
* Number of milliseconds in a day.
6164
*
6265
* @example
63-
* var num = MILLISECONDS_IN_DAY;
66+
* var num = time.MILLISECONDS_IN_DAY;
6467
* // returns 86400000
6568
*/
6669
MILLISECONDS_IN_DAY: typeof MILLISECONDS_IN_DAY;
@@ -69,7 +72,7 @@ interface TIME {
6972
* Number of milliseconds in an hour.
7073
*
7174
* @example
72-
* var num = MILLISECONDS_IN_HOUR;
75+
* var num = time.MILLISECONDS_IN_HOUR;
7376
* // returns 3600000
7477
*/
7578
MILLISECONDS_IN_HOUR: typeof MILLISECONDS_IN_HOUR;
@@ -78,7 +81,7 @@ interface TIME {
7881
* Number of milliseconds in a minute.
7982
*
8083
* @example
81-
* var num = MILLISECONDS_IN_MINUTE;
84+
* var num = time.MILLISECONDS_IN_MINUTE;
8285
* // returns 60000
8386
*/
8487
MILLISECONDS_IN_MINUTE: typeof MILLISECONDS_IN_MINUTE;
@@ -87,7 +90,7 @@ interface TIME {
8790
* Number of milliseconds in a second.
8891
*
8992
* @example
90-
* var num = MILLISECONDS_IN_SECOND;
93+
* var num = time.MILLISECONDS_IN_SECOND;
9194
* // returns 1000
9295
*/
9396
MILLISECONDS_IN_SECOND: typeof MILLISECONDS_IN_SECOND;
@@ -96,7 +99,7 @@ interface TIME {
9699
* Number of milliseconds in a week.
97100
*
98101
* @example
99-
* var num = MILLISECONDS_IN_WEEK;
102+
* var num = time.MILLISECONDS_IN_WEEK;
100103
* // returns 604800000
101104
*/
102105
MILLISECONDS_IN_WEEK: typeof MILLISECONDS_IN_WEEK;
@@ -105,7 +108,7 @@ interface TIME {
105108
* Number of minutes in a day.
106109
*
107110
* @example
108-
* var num = MINUTES_IN_DAY;
111+
* var num = time.MINUTES_IN_DAY;
109112
* // returns 1440
110113
*/
111114
MINUTES_IN_DAY: typeof MINUTES_IN_DAY;
@@ -114,7 +117,7 @@ interface TIME {
114117
* Number of minutes in an hour.
115118
*
116119
* @example
117-
* var num = MINUTES_IN_HOUR;
120+
* var num = time.MINUTES_IN_HOUR;
118121
* // returns 60
119122
*/
120123
MINUTES_IN_HOUR: typeof MINUTES_IN_HOUR;
@@ -123,7 +126,7 @@ interface TIME {
123126
* Number of minutes in a week.
124127
*
125128
* @example
126-
* var num = MINUTES_IN_WEEK;
129+
* var num = time.MINUTES_IN_WEEK;
127130
* // returns 10080
128131
*/
129132
MINUTES_IN_WEEK: typeof MINUTES_IN_WEEK;
@@ -132,7 +135,7 @@ interface TIME {
132135
* Number of months in a year.
133136
*
134137
* @example
135-
* var num = MONTHS_IN_YEAR;
138+
* var num = time.MONTHS_IN_YEAR;
136139
* // returns 12
137140
*/
138141
MONTHS_IN_YEAR: typeof MONTHS_IN_YEAR;
@@ -141,7 +144,7 @@ interface TIME {
141144
* Number of seconds in a day.
142145
*
143146
* @example
144-
* var num = SECONDS_IN_DAY;
147+
* var num = time.SECONDS_IN_DAY;
145148
* // returns 86400
146149
*/
147150
SECONDS_IN_DAY: typeof SECONDS_IN_DAY;
@@ -150,7 +153,7 @@ interface TIME {
150153
* Number of seconds in an hour.
151154
*
152155
* @example
153-
* var num = SECONDS_IN_HOUR;
156+
* var num = time.SECONDS_IN_HOUR;
154157
* // returns 3600
155158
*/
156159
SECONDS_IN_HOUR: typeof SECONDS_IN_HOUR;
@@ -159,7 +162,7 @@ interface TIME {
159162
* Number of seconds in a minute.
160163
*
161164
* @example
162-
* var num = SECONDS_IN_MINUTE;
165+
* var num = time.SECONDS_IN_MINUTE;
163166
* // returns 60
164167
*/
165168
SECONDS_IN_MINUTE: typeof SECONDS_IN_MINUTE;
@@ -168,7 +171,7 @@ interface TIME {
168171
* Number of seconds in a week.
169172
*
170173
* @example
171-
* var num = SECONDS_IN_WEEK;
174+
* var num = time.SECONDS_IN_WEEK;
172175
* // returns 604800
173176
*/
174177
SECONDS_IN_WEEK: typeof SECONDS_IN_WEEK;

‎lib/node_modules/@stdlib/constants/time/docs/types/test.ts‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,7 @@ import time = require( './index' );
2323

2424
// TESTS //
2525

26-
// The exported object has the expected function interfaces...
26+
// The exported value is the expected interface...
2727
{
28-
time.HOURS_IN_DAY; // $ExpectType number
29-
time.HOURS_IN_WEEK; // $ExpectType number
30-
time.MILLISECONDS_IN_DAY; // $ExpectType number
31-
time.MILLISECONDS_IN_HOUR; // $ExpectType number
32-
time.MILLISECONDS_IN_MINUTE; // $ExpectType number
33-
time.MILLISECONDS_IN_SECOND; // $ExpectType number
34-
time.MILLISECONDS_IN_WEEK; // $ExpectType number
35-
time.MINUTES_IN_DAY; // $ExpectType number
36-
time.MINUTES_IN_HOUR; // $ExpectType number
37-
time.MINUTES_IN_WEEK; // $ExpectType number
38-
time.MONTHS_IN_YEAR; // $ExpectType number
39-
time.SECONDS_IN_DAY; // $ExpectType number
40-
time.SECONDS_IN_HOUR; // $ExpectType number
41-
time.SECONDS_IN_MINUTE; // $ExpectType number
42-
time.SECONDS_IN_WEEK; // $ExpectType number
28+
time; // $ExpectType TIME
4329
}

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

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818

1919
// TypeScript Version: 2.0
2020

21+
/* tslint:disable:max-line-length */
22+
/* tslint:disable:max-file-line-count */
23+
2124
import close = require( '@stdlib/fs/close' );
2225
import exists = require( '@stdlib/fs/exists' );
2326
import open = require( '@stdlib/fs/open' );
@@ -55,7 +58,7 @@ interface FS {
5558
* throw fd;
5659
* }
5760
*
58-
* close( fd, done );
61+
* fs.close( fd, done );
5962
*
6063
* @example
6164
* var openSync = require( `@stdlib/fs/open` ).sync;
@@ -66,7 +69,7 @@ interface FS {
6669
* throw fd;
6770
* }
6871
*
69-
* var err = close.sync( fd );
72+
* var err = fs.close.sync( fd );
7073
* if ( err instanceof Error ) {
7174
* throw err;
7275
* }
@@ -80,21 +83,21 @@ interface FS {
8083
* @param clbk - callback to invoke after testing path existence
8184
*
8285
* @example
83-
* exists( __dirname, done );
86+
* fs.exists( __dirname, done );
8487
*
8588
* function done( error, bool ) {
8689
* if ( error ) {
8790
* console.error( error );
8891
* }
8992
* if ( bool ) {
90-
* console.log( '...path exists.' );
93+
* console.log( '...path fs.exists.' );
9194
* } else {
9295
* console.log( '...path does not exist.' );
9396
* }
9497
* }
9598
*
9699
* @example
97-
* var bool = exists.sync( __dirname );
100+
* var bool = fs.exists.sync( __dirname );
98101
* // returns <boolean>
99102
*/
100103
exists: typeof exists;
@@ -116,12 +119,12 @@ interface FS {
116119
* }
117120
* closeSync( fd );
118121
* }
119-
* open( __filename, onOpen );
122+
* fs.open( __filename, onOpen );
120123
*
121124
* @example
122125
* var closeSync = require( `@stdlib/fs/close` ).sync;
123126
*
124-
* var fd = open.sync( __filename );
127+
* var fd = fs.open.sync( __filename );
125128
* if ( fd instanceof Error ) {
126129
* throw fd;
127130
* }
@@ -143,10 +146,10 @@ interface FS {
143146
* console.log( data );
144147
* }
145148
* }
146-
* readDir( __dirname, onRead );
149+
* fs.readDir( __dirname, onRead );
147150
*
148151
* @example
149-
* var out = readDir.sync( __dirname );
152+
* var out = fs.readDir.sync( __dirname );
150153
* if ( out instanceof Error ) {
151154
* throw out;
152155
* }
@@ -170,10 +173,10 @@ interface FS {
170173
* }
171174
* console.log( data );
172175
* }
173-
* readFile( __filename, onFile );
176+
* fs.readFile( __filename, onFile );
174177
*
175178
* @example
176-
* var out = readFile.sync( __filename );
179+
* var out = fs.readFile.sync( __filename );
177180
* if ( out instanceof Error ) {
178181
* throw out;
179182
* }
@@ -193,7 +196,7 @@ interface FS {
193196
* @example
194197
* var list = [ __filename ];
195198
*
196-
* readFileList( list, onFiles );
199+
* fs.readFileList( list, onFiles );
197200
*
198201
* function onFiles( error, files ) {
199202
* if ( error ) {
@@ -204,7 +207,7 @@ interface FS {
204207
*
205208
* @example
206209
* var list = [ __filename ];
207-
* var files = readFileList.sync( list );
210+
* var files = fs.readFileList.sync( list );
208211
*
209212
* if ( files instanceof Error ) {
210213
* throw files;
@@ -226,7 +229,7 @@ interface FS {
226229
* @example
227230
* var resolve = require( `path` ).resolve;
228231
*
229-
* readJSON( resolve( __dirname, '..', 'package.json' ), 'utf-8', onJSON );
232+
* fs.readJSON( resolve( __dirname, '..', 'package.json' ), 'utf-8', onJSON );
230233
*
231234
* function onJSON( error, data ) {
232235
* if ( error ) {
@@ -239,7 +242,7 @@ interface FS {
239242
* var resolve = require( `path` ).resolve;
240243
* var instanceOf = require( `@stdlib/assert/instance-of` );
241244
*
242-
* var out = readJSON.sync( resolve( __dirname, '..', 'package.json' ) );
245+
* var out = fs.readJSON.sync( resolve( __dirname, '..', 'package.json' ) );
243246
* if ( instanceOf( out, Error ) ) {
244247
* throw out;
245248
* }
@@ -260,7 +263,7 @@ interface FS {
260263
* var instanceOf = require( `@stdlib/assert/instance-of` );
261264
*
262265
* var fpath = join( __dirname, 'foo.wasm' );
263-
* readWASM( fpath, onRead );
266+
* fs.readWASM( fpath, onRead );
264267
*
265268
* function onRead( error, buf ) {
266269
* if ( error ) {
@@ -274,7 +277,7 @@ interface FS {
274277
* var instanceOf = require( `@stdlib/assert/instance-of` );
275278
*
276279
* var fpath = join( __dirname, 'foo.wasm' );
277-
* var out = readWASM.sync( fpath );
280+
* var out = fs.readWASM.sync( fpath );
278281
* if ( instanceOf( out, Error ) ) {
279282
* throw out;
280283
* }
@@ -296,10 +299,10 @@ interface FS {
296299
* }
297300
* }
298301
*
299-
* rename( './beep/boop.txt', './beep/foo.txt', done );
302+
* fs.rename( './beep/boop.txt', './beep/foo.txt', done );
300303
*
301304
* @example
302-
* var err = rename.sync( './beep/boop.txt', './beep/foo.txt' );
305+
* var err = fs.rename.sync( './beep/boop.txt', './beep/foo.txt' );
303306
* if ( err instanceof Error ) {
304307
* throw err;
305308
* }
@@ -316,7 +319,7 @@ interface FS {
316319
* @throws must provide valid options
317320
*
318321
* @example
319-
* resolveParentPath( 'package.json', onPath );
322+
* fs.resolveParentPath( 'package.json', onPath );
320323
*
321324
* function onPath( error, path ) {
322325
* if ( error ) {
@@ -326,7 +329,7 @@ interface FS {
326329
* }
327330
*
328331
* @example
329-
* var path = resolveParentPath.sync( 'package.json' );
332+
* var path = fs.resolveParentPath.sync( 'package.json' );
330333
*/
331334
resolveParentPath: typeof resolveParentPath;
332335

@@ -342,10 +345,10 @@ interface FS {
342345
* throw error;
343346
* }
344347
* }
345-
* unlink( './beep/boop.txt', done );
348+
* fs.unlink( './beep/boop.txt', done );
346349
*
347350
* @example
348-
* var err = unlink.sync( './beep/boop.txt' );
351+
* var err = fs.unlink.sync( './beep/boop.txt' );
349352
* if ( err instanceof Error ) {
350353
* throw err;
351354
* }

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

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,7 @@ import fs = require( './index' );
2323

2424
// TESTS //
2525

26-
// The exported object has the expected function interfaces...
26+
// The exported value is the expected interface...
2727
{
28-
fs.close; // $ExpectType Close
29-
fs.exists; // $ExpectType Exists
30-
fs.open; // $ExpectType Open
31-
fs.readDir; // $ExpectType ReadDir
32-
fs.readFile; // $ExpectType ReadFile
33-
fs.readFileList; // $ExpectType ReadFileList
34-
fs.readJSON; // $ExpectType ReadJSON
35-
fs.readWASM; // $ExpectType ReadWASM
36-
fs.rename; // $ExpectType Rename
37-
fs.resolveParentPath; // $ExpectType ResolveParentPath
38-
fs.unlink; // $ExpectType Unlink
28+
fs; // $ExpectType FS
3929
}

0 commit comments

Comments
 (0)