Skip to content

Commit 00be223

Browse files
committed
docs: update README examples to use const and let
1 parent acba45b commit 00be223

File tree

23 files changed

+276
-310
lines changed

23 files changed

+276
-310
lines changed

lib/node_modules/@stdlib/_tools/modules/import-require/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,18 +33,18 @@ limitations under the License.
3333
## Usage
3434

3535
```javascript
36-
var ls = require( '@stdlib/_tools/modules/import-require' );
36+
const ls = require( '@stdlib/_tools/modules/import-require' );
3737
```
3838

3939
#### ls( src )
4040

4141
Searches for import and require paths in a source `string` or [`Buffer`][node-buffer].
4242

4343
```javascript
44-
var readFile = require( '@stdlib/fs/read-file' ).sync;
44+
const readFile = require( '@stdlib/fs/read-file' ).sync;
4545

46-
var src = readFile( __filename );
47-
var results = ls( src );
46+
const src = readFile( __filename );
47+
const results = ls( src );
4848

4949
console.dir( results );
5050
```
@@ -67,11 +67,11 @@ The returned `object` has the following fields:
6767
<!-- eslint-disable stdlib/no-dynamic-require, no-useless-concat -->
6868

6969
```javascript
70-
var ls = require( '@stdlib/_tools/modules/import-require' );
71-
var readFile = require( '@stdlib'+'/fs/read-file' ).sync;
70+
const ls = require( '@stdlib/_tools/modules/import-require' );
71+
const readFile = require( '@stdlib'+'/fs/read-file' ).sync;
7272

73-
var src = readFile( __filename );
74-
var results = ls( src );
73+
const src = readFile( __filename );
74+
const results = ls( src );
7575
/* returns
7676
{
7777
'literals': [ '@stdlib/_tools/modules/import-require' ],
@@ -89,11 +89,11 @@ The returned `object` has the following fields:
8989
<!-- eslint no-undef: "error" -->
9090

9191
```javascript
92-
var readFile = require( '@stdlib/fs/read-file' ).sync;
93-
var ls = require( '@stdlib/_tools/modules/import-require' );
92+
const readFile = require( '@stdlib/fs/read-file' ).sync;
93+
const ls = require( '@stdlib/_tools/modules/import-require' );
9494
95-
var file = readFile( __filename );
96-
var results = ls( file );
95+
const file = readFile( __filename );
96+
const results = ls( file );
9797
9898
console.log( 'Literals:' );
9999
console.dir( results.literals );

lib/node_modules/@stdlib/_tools/pkgs/name2standalone/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,26 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var name2standalone = require( '@stdlib/_tools/pkgs/name2standalone' );
30+
const name2standalone = require( '@stdlib/_tools/pkgs/name2standalone' );
3131
```
3232

3333
#### name2standalone( name )
3434

3535
Converts a stdlib package `name` (or a list of package names) to a standalone package name.
3636

3737
```javascript
38-
var out = name2standalone( '@stdlib/math/base/special/sin' );
38+
const out = name2standalone( '@stdlib/math/base/special/sin' );
3939
// returns '@stdlib/math-base-special-sin'
4040
```
4141

4242
To convert more than one stdlib package `name`, provide a list of package names.
4343

4444
```javascript
45-
var list = [
45+
const list = [
4646
'@stdlib/math/base/special/sin',
4747
'@stdlib/math/base/special/cos'
4848
];
49-
var out = name2standalone( list );
49+
const out = name2standalone( list );
5050
// returns [ '@stdlib/math-base-special-sin', '@stdlib/math-base-special-cos' ]
5151
```
5252

@@ -61,7 +61,7 @@ var out = name2standalone( list );
6161
- Non-stdlib package names are returned unchanged.
6262

6363
```javascript
64-
var out = name2standalone( 'tape' );
64+
const out = name2standalone( 'tape' );
6565
// returns 'tape'
6666
```
6767

@@ -76,21 +76,21 @@ var out = name2standalone( list );
7676
<!-- eslint no-undef: "error" -->
7777

7878
```javascript
79-
var join = require( 'path' ).join;
80-
var pkgNames = require( '@stdlib/_tools/pkgs/names' ).sync;
81-
var rootDir = require( '@stdlib/_tools/utils/root-dir' );
82-
var name2standalone = require( '@stdlib/_tools/pkgs/name2standalone' );
79+
const join = require( 'path' ).join;
80+
const pkgNames = require( '@stdlib/_tools/pkgs/names' ).sync;
81+
const rootDir = require( '@stdlib/_tools/utils/root-dir' );
82+
const name2standalone = require( '@stdlib/_tools/pkgs/name2standalone' );
8383
8484
// Resolve a namespace directory:
85-
var dir = join( rootDir(), 'lib', 'node_modules', '@stdlib', 'math', 'base', 'special' );
85+
const dir = join( rootDir(), 'lib', 'node_modules', '@stdlib', 'math', 'base', 'special' );
8686
8787
// Resolve a list of package names:
88-
var names = pkgNames({
88+
const names = pkgNames({
8989
'dir': dir
9090
});
9191
9292
// Convert to standalone package names:
93-
var out = name2standalone( names );
93+
const out = name2standalone( names );
9494
console.log( out.join( '\n' ) );
9595
```
9696

lib/node_modules/@stdlib/bench/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ limitations under the License.
3737
## Usage
3838

3939
```javascript
40-
var bench = require( '@stdlib/bench' );
40+
const bench = require( '@stdlib/bench' );
4141
```
4242

4343
#### bench( name\[, options]\[, benchmark] )

lib/node_modules/@stdlib/cli/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var ns = require( '@stdlib/cli' );
30+
const ns = require( '@stdlib/cli' );
3131
```
3232

3333
#### ns
3434

3535
Command-line interface namespace.
3636

3737
```javascript
38-
var o = ns;
38+
const o = ns;
3939
// returns {...}
4040
```
4141

@@ -64,8 +64,8 @@ The namespace contains the following:
6464
<!-- eslint no-undef: "error" -->
6565

6666
```javascript
67-
var objectKeys = require( '@stdlib/utils/keys' );
68-
var ns = require( '@stdlib/cli' );
67+
const objectKeys = require( '@stdlib/utils/keys' );
68+
const ns = require( '@stdlib/cli' );
6969

7070
console.log( objectKeys( ns ) );
7171
```

0 commit comments

Comments
 (0)