Skip to content

Commit 37fac4b

Browse files
committed
Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop
2 parents a3f4c26 + e2a2dc0 commit 37fac4b

File tree

113 files changed

+294
-634
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

113 files changed

+294
-634
lines changed

lib/node_modules/@stdlib/_tools/package-json/scripts/update_names

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var resolve = require( 'path' ).resolve;
1818
var logger = require( 'debug' );
1919
var writeFile = require( '@stdlib/fs/write-file' ).sync;
2020
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
21-
var SEP = require( '@stdlib/constants/string/path/sep' );
21+
var SEP = require( '@stdlib/constants/path/sep' );
2222
var findPkgs = require( '@stdlib/_tools/pkgs/find' ).sync;
2323

2424

lib/node_modules/@stdlib/_tools/package-json/scripts/update_tools_names

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ var resolve = require( 'path' ).resolve;
1818
var logger = require( 'debug' );
1919
var writeFile = require( '@stdlib/fs/write-file' ).sync;
2020
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
21-
var SEP = require( '@stdlib/constants/string/path/sep' );
21+
var SEP = require( '@stdlib/constants/path/sep' );
2222
var findPkgs = require( '@stdlib/_tools/pkgs/find' ).sync;
2323

2424

lib/node_modules/@stdlib/_tools/pkgs/namespaces/lib/filter.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
2424
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
2525
var isObject = require( '@stdlib/assert/is-plain-object' );
26-
var PATH_SEP = require( '@stdlib/constants/string/path/sep' );
26+
var PATH_SEP = require( '@stdlib/constants/path/sep' );
2727

2828

2929
// MAIN //

lib/node_modules/@stdlib/_tools/pkgs/tree/lib/tree.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
2424
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
2525
var isObject = require( '@stdlib/assert/is-plain-object' );
26-
var PATH_SEP = require( '@stdlib/constants/string/path/sep' );
26+
var PATH_SEP = require( '@stdlib/constants/path/sep' );
2727

2828

2929
// MAIN //

lib/node_modules/@stdlib/_tools/remark/plugins/remark-img-equations-src-urls/lib/transformer.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve;
2424
var join = require( 'path' ).join;
2525
var logger = require( 'debug' );
2626
var visit = require( 'unist-util-visit' );
27-
var PATH_SEP = require( '@stdlib/constants/string/path/sep' );
27+
var PATH_SEP = require( '@stdlib/constants/path/sep' );
2828
var rawgit = require( '@stdlib/_tools/utils/rawgit-url' );
2929
var git = require( './git.js' );
3030

lib/node_modules/@stdlib/assert/has-utf16-surrogate-pair-at/benchmark/benchmark.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ var randu = require( '@stdlib/random/base/randu' );
2525
var floor = require( '@stdlib/math/base/special/floor' );
2626
var fromCodePoint = require( '@stdlib/string/from-code-point' );
2727
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
28-
var UNICODE_MAX = require( '@stdlib/constants/string/unicode/max' );
28+
var UNICODE_MAX = require( '@stdlib/constants/unicode/max' );
2929
var pkg = require( './../package.json' ).name;
3030
var hasUTF16SurrogatePairAt = require( './../lib' );
3131

lib/node_modules/@stdlib/constants/lib/index.js

+12-3
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,13 @@ setReadOnly( ns, 'int16', require( '@stdlib/constants/int16' ) );
118118
setReadOnly( ns, 'int32', require( '@stdlib/constants/int32' ) );
119119

120120
/**
121-
* @name string
121+
* @name path
122122
* @memberof ns
123123
* @readonly
124124
* @type {Namespace}
125-
* @see {@link module:@stdlib/constants/string}
125+
* @see {@link module:@stdlib/constants/path}
126126
*/
127-
setReadOnly( ns, 'string', require( '@stdlib/constants/string' ) );
127+
setReadOnly( ns, 'path', require( '@stdlib/constants/path' ) );
128128

129129
/**
130130
* @name time
@@ -162,6 +162,15 @@ setReadOnly( ns, 'uint16', require( '@stdlib/constants/uint16' ) );
162162
*/
163163
setReadOnly( ns, 'uint32', require( '@stdlib/constants/uint32' ) );
164164

165+
/**
166+
* @name unicode
167+
* @memberof ns
168+
* @readonly
169+
* @type {Namespace}
170+
* @see {@link module:@stdlib/constants/unicode}
171+
*/
172+
setReadOnly( ns, 'unicode', require( '@stdlib/constants/unicode' ) );
173+
165174

166175
// EXPORTS //
167176

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2021 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# String Path Constants
22+
23+
> Standard library string path constants.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var constants = require( '@stdlib/constants/path' );
31+
```
32+
33+
#### constants
34+
35+
Standard library string path constants.
36+
37+
```javascript
38+
var ns = constants;
39+
// returns {...}
40+
```
41+
42+
<!-- <toc pattern="*"> -->
43+
44+
<div class="namespace-toc">
45+
46+
- <span class="signature">[`DELIMITER_POSIX`][@stdlib/constants/path/delimiter-posix]</span><span class="delimiter">: </span><span class="description">POSIX path delimiter.</span>
47+
- <span class="signature">[`DELIMITER_WIN32`][@stdlib/constants/path/delimiter-win32]</span><span class="delimiter">: </span><span class="description">Windows path delimiter.</span>
48+
- <span class="signature">[`DELIMITER`][@stdlib/constants/path/delimiter]</span><span class="delimiter">: </span><span class="description">platform-specific path delimiter.</span>
49+
- <span class="signature">[`SEP_POSIX`][@stdlib/constants/path/sep-posix]</span><span class="delimiter">: </span><span class="description">POSIX path segment separator.</span>
50+
- <span class="signature">[`SEP_WIN32`][@stdlib/constants/path/sep-win32]</span><span class="delimiter">: </span><span class="description">Windows path segment separator.</span>
51+
- <span class="signature">[`SEP`][@stdlib/constants/path/sep]</span><span class="delimiter">: </span><span class="description">platform-specific path segment separator.</span>
52+
53+
</div>
54+
55+
<!-- </toc> -->
56+
57+
</section>
58+
59+
<!-- /.usage -->
60+
61+
<section class="examples">
62+
63+
## Examples
64+
65+
<!-- TODO: better examples -->
66+
67+
<!-- eslint no-undef: "error" -->
68+
69+
```javascript
70+
var objectKeys = require( '@stdlib/utils/keys' );
71+
var constants = require( '@stdlib/constants/path' );
72+
73+
console.log( objectKeys( constants ) );
74+
```
75+
76+
</section>
77+
78+
<!-- /.examples -->
79+
80+
<section class="links">
81+
82+
<!-- <toc-links> -->
83+
84+
[@stdlib/constants/path/delimiter-posix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/path/delimiter-posix
85+
86+
[@stdlib/constants/path/delimiter-win32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/path/delimiter-win32
87+
88+
[@stdlib/constants/path/delimiter]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/path/delimiter
89+
90+
[@stdlib/constants/path/sep-posix]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/path/sep-posix
91+
92+
[@stdlib/constants/path/sep-win32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/path/sep-win32
93+
94+
[@stdlib/constants/path/sep]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/path/sep
95+
96+
<!-- </toc-links> -->
97+
98+
</section>
99+
100+
<!-- /.links -->

lib/node_modules/@stdlib/constants/string/path/delimiter-posix/README.md renamed to lib/node_modules/@stdlib/constants/path/delimiter-posix/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/string/path/delimiter-posix' );
30+
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/path/delimiter-posix' );
3131
```
3232

3333
#### PATH_DELIMITER_POSIX
@@ -50,7 +50,7 @@ var delimiter = PATH_DELIMITER_POSIX;
5050
<!-- eslint no-undef: "error" -->
5151

5252
```javascript
53-
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/string/path/delimiter-posix' );
53+
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/path/delimiter-posix' );
5454

5555
var PATH = '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin';
5656
var paths = PATH.split( PATH_DELIMITER_POSIX );

lib/node_modules/@stdlib/constants/string/path/delimiter-posix/lib/index.js renamed to lib/node_modules/@stdlib/constants/path/delimiter-posix/lib/index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
/**
2222
* POSIX path delimiter.
2323
*
24-
* @module @stdlib/constants/string/path/delimiter-posix
24+
* @module @stdlib/constants/path/delimiter-posix
2525
* @type {string}
2626
*
2727
* @example
28-
* var PATH_DELIMITER_POSIX = require( '@stdlib/constants/string/path/delimiter-posix' );
28+
* var PATH_DELIMITER_POSIX = require( '@stdlib/constants/path/delimiter-posix' );
2929
*
3030
* var PATH = '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin';
3131
* var paths = PATH.split( PATH_DELIMITER_POSIX );

lib/node_modules/@stdlib/constants/string/path/delimiter-posix/package.json renamed to lib/node_modules/@stdlib/constants/path/delimiter-posix/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@stdlib/constants/string/path/delimiter-posix",
2+
"name": "@stdlib/constants/path/delimiter-posix",
33
"version": "0.0.0",
44
"description": "POSIX path delimiter.",
55
"license": "Apache-2.0",

lib/node_modules/@stdlib/constants/string/path/delimiter-win32/README.md renamed to lib/node_modules/@stdlib/constants/path/delimiter-win32/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/string/path/delimiter-win32' );
30+
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/path/delimiter-win32' );
3131
```
3232

3333
#### PATH_DELIMITER_WIN32
@@ -50,7 +50,7 @@ var delimiter = PATH_DELIMITER_WIN32;
5050
<!-- eslint no-undef: "error" -->
5151

5252
```javascript
53-
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/string/path/delimiter-win32' );
53+
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/path/delimiter-win32' );
5454

5555
var PATH = 'C:\\Windows\\system32;C:\\Windows;C:\\Program Files\\node\\';
5656
var paths = PATH.split( PATH_DELIMITER_WIN32 );

lib/node_modules/@stdlib/constants/string/path/delimiter-win32/lib/index.js renamed to lib/node_modules/@stdlib/constants/path/delimiter-win32/lib/index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121
/**
2222
* Windows path delimiter.
2323
*
24-
* @module @stdlib/constants/string/path/delimiter-win32
24+
* @module @stdlib/constants/path/delimiter-win32
2525
* @type {string}
2626
*
2727
* @example
28-
* var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/string/path/delimiter-win32' );
28+
* var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/path/delimiter-win32' );
2929
*
3030
* var PATH = 'C:\\Windows\\system32;C:\\Windows;C:\\Program Files\\node\\';
3131
* var paths = PATH.split( PATH_DELIMITER_WIN32 );

lib/node_modules/@stdlib/constants/string/path/delimiter-win32/package.json renamed to lib/node_modules/@stdlib/constants/path/delimiter-win32/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@stdlib/constants/string/path/delimiter-win32",
2+
"name": "@stdlib/constants/path/delimiter-win32",
33
"version": "0.0.0",
44
"description": "Windows path delimiter.",
55
"license": "Apache-2.0",

lib/node_modules/@stdlib/constants/string/path/delimiter/README.md renamed to lib/node_modules/@stdlib/constants/path/delimiter/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ limitations under the License.
2727
## Usage
2828

2929
```javascript
30-
var PATH_DELIMITER = require( '@stdlib/constants/string/path/delimiter' );
30+
var PATH_DELIMITER = require( '@stdlib/constants/path/delimiter' );
3131
```
3232

3333
#### PATH_DELIMITER
@@ -59,7 +59,7 @@ if ( IS_WINDOWS ) {
5959

6060
```javascript
6161
var IS_WINDOWS = require( '@stdlib/assert/is-windows' );
62-
var PATH_DELIMITER = require( '@stdlib/constants/string/path/delimiter' );
62+
var PATH_DELIMITER = require( '@stdlib/constants/path/delimiter' );
6363

6464
var paths;
6565
var PATH;

lib/node_modules/@stdlib/constants/string/path/delimiter/lib/index.js renamed to lib/node_modules/@stdlib/constants/path/delimiter/lib/index.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@
2121
/**
2222
* Platform-specific path delimiter.
2323
*
24-
* @module @stdlib/constants/string/path/delimiter
24+
* @module @stdlib/constants/path/delimiter
2525
* @type {string}
2626
*
2727
* @example
2828
* var IS_WINDOWS = require( '@stdlib/assert/is-windows' );
29-
* var PATH_DELIMITER = require( '@stdlib/constants/string/path/delimiter' );
29+
* var PATH_DELIMITER = require( '@stdlib/constants/path/delimiter' );
3030
*
3131
* var PATH;
3232
* var paths;
@@ -45,8 +45,8 @@
4545
// MODULES //
4646

4747
var IS_WINDOWS = require( '@stdlib/assert/is-windows' );
48-
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/string/path/delimiter-win32' );
49-
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/string/path/delimiter-posix' );
48+
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/path/delimiter-win32' );
49+
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/path/delimiter-posix' );
5050

5151

5252
// MAIN //

lib/node_modules/@stdlib/constants/string/path/delimiter/package.json renamed to lib/node_modules/@stdlib/constants/path/delimiter/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@stdlib/constants/string/path/delimiter",
2+
"name": "@stdlib/constants/path/delimiter",
33
"version": "0.0.0",
44
"description": "Platform-specific path delimiter.",
55
"license": "Apache-2.0",

lib/node_modules/@stdlib/constants/string/path/delimiter/test/test.js renamed to lib/node_modules/@stdlib/constants/path/delimiter/test/test.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222

2323
var tape = require( 'tape' );
2424
var proxyquire = require( 'proxyquire' );
25-
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/string/path/delimiter-posix' );
26-
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/string/path/delimiter-win32' );
25+
var PATH_DELIMITER_POSIX = require( '@stdlib/constants/path/delimiter-posix' );
26+
var PATH_DELIMITER_WIN32 = require( '@stdlib/constants/path/delimiter-win32' );
2727
var PATH_DELIMITER = require( './../lib' );
2828

2929

0 commit comments

Comments
 (0)