Skip to content

Commit f66a7e1

Browse files
stdlib-botstdlib-bot
committed
Auto-generated commit
1 parent 6da9df6 commit f66a7e1

File tree

15 files changed

+765
-2
lines changed

15 files changed

+765
-2
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
### Features
1212

13+
- [`d910139`](https://github.com/stdlib-js/stdlib/commit/d91013957b34fc5bff6d3eeb0b6c9390787d545f) - add `assert/has-search-symbol-support` [(#8477)](https://github.com/stdlib-js/stdlib/pull/8477)
1314
- [`b2d0f92`](https://github.com/stdlib-js/stdlib/commit/b2d0f928d2f89a6b706df19584e4dd68f5819f48) - add `assert/has-match-symbol-support` [(#8474)](https://github.com/stdlib-js/stdlib/pull/8474)
1415
- [`46fb33c`](https://github.com/stdlib-js/stdlib/commit/46fb33ca451cabba3f34babd9c8e7867393817d3) - add `assert/has-replace-symbol-support` [(#8472)](https://github.com/stdlib-js/stdlib/pull/8472)
1516
- [`b18ecdd`](https://github.com/stdlib-js/stdlib/commit/b18ecdd324030deecb2f4fc7564d4218916ae7a9) - add `assert/has-to-primitive-symbol-support` [(#8469)](https://github.com/stdlib-js/stdlib/pull/8469)
@@ -119,9 +120,9 @@
119120

120121
### Closed Issues
121122

122-
A total of 22 issues were closed in this release:
123+
A total of 23 issues were closed in this release:
123124

124-
[#5814](https://github.com/stdlib-js/stdlib/issues/5814), [#6901](https://github.com/stdlib-js/stdlib/issues/6901), [#6925](https://github.com/stdlib-js/stdlib/issues/6925), [#7084](https://github.com/stdlib-js/stdlib/issues/7084), [#7107](https://github.com/stdlib-js/stdlib/issues/7107), [#7199](https://github.com/stdlib-js/stdlib/issues/7199), [#8013](https://github.com/stdlib-js/stdlib/issues/8013), [#8043](https://github.com/stdlib-js/stdlib/issues/8043), [#8050](https://github.com/stdlib-js/stdlib/issues/8050), [#8082](https://github.com/stdlib-js/stdlib/issues/8082), [#8088](https://github.com/stdlib-js/stdlib/issues/8088), [#8114](https://github.com/stdlib-js/stdlib/issues/8114), [#8129](https://github.com/stdlib-js/stdlib/issues/8129), [#8135](https://github.com/stdlib-js/stdlib/issues/8135), [#8169](https://github.com/stdlib-js/stdlib/issues/8169), [#8195](https://github.com/stdlib-js/stdlib/issues/8195), [#8208](https://github.com/stdlib-js/stdlib/issues/8208), [#8235](https://github.com/stdlib-js/stdlib/issues/8235), [#8244](https://github.com/stdlib-js/stdlib/issues/8244), [#8464](https://github.com/stdlib-js/stdlib/issues/8464), [#8465](https://github.com/stdlib-js/stdlib/issues/8465), [#8468](https://github.com/stdlib-js/stdlib/issues/8468)
125+
[#5814](https://github.com/stdlib-js/stdlib/issues/5814), [#6901](https://github.com/stdlib-js/stdlib/issues/6901), [#6925](https://github.com/stdlib-js/stdlib/issues/6925), [#7084](https://github.com/stdlib-js/stdlib/issues/7084), [#7107](https://github.com/stdlib-js/stdlib/issues/7107), [#7199](https://github.com/stdlib-js/stdlib/issues/7199), [#8013](https://github.com/stdlib-js/stdlib/issues/8013), [#8043](https://github.com/stdlib-js/stdlib/issues/8043), [#8050](https://github.com/stdlib-js/stdlib/issues/8050), [#8082](https://github.com/stdlib-js/stdlib/issues/8082), [#8088](https://github.com/stdlib-js/stdlib/issues/8088), [#8114](https://github.com/stdlib-js/stdlib/issues/8114), [#8129](https://github.com/stdlib-js/stdlib/issues/8129), [#8135](https://github.com/stdlib-js/stdlib/issues/8135), [#8169](https://github.com/stdlib-js/stdlib/issues/8169), [#8195](https://github.com/stdlib-js/stdlib/issues/8195), [#8208](https://github.com/stdlib-js/stdlib/issues/8208), [#8235](https://github.com/stdlib-js/stdlib/issues/8235), [#8244](https://github.com/stdlib-js/stdlib/issues/8244), [#8464](https://github.com/stdlib-js/stdlib/issues/8464), [#8465](https://github.com/stdlib-js/stdlib/issues/8465), [#8466](https://github.com/stdlib-js/stdlib/issues/8466), [#8468](https://github.com/stdlib-js/stdlib/issues/8468)
125126

126127
</section>
127128

@@ -133,6 +134,7 @@ A total of 22 issues were closed in this release:
133134

134135
<details>
135136

137+
- [`d910139`](https://github.com/stdlib-js/stdlib/commit/d91013957b34fc5bff6d3eeb0b6c9390787d545f) - **feat:** add `assert/has-search-symbol-support` [(#8477)](https://github.com/stdlib-js/stdlib/pull/8477) _(by kaushal-kumar-it, Athan Reines)_
136138
- [`8124fc0`](https://github.com/stdlib-js/stdlib/commit/8124fc07ea87df5b78dbfd7c7206c84e6fdd9fe0) - **docs:** update heading _(by Athan Reines)_
137139
- [`35af82b`](https://github.com/stdlib-js/stdlib/commit/35af82b85c84df01c315e7e94551c3a9de16a788) - **docs:** update heading _(by Athan Reines)_
138140
- [`89d75db`](https://github.com/stdlib-js/stdlib/commit/89d75db78c28f00b7afe2b9aac598cafa41e9c05) - **docs:** update heading _(by Athan Reines)_

‎has-search-symbol-support/README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 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+
# hasSearchSymbolSupport
22+
23+
> Detect native [`Symbol.search`][mdn-search-symbol] support.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
```javascript
30+
var hasSearchSymbolSupport = require( '@stdlib/assert/has-search-symbol-support' );
31+
```
32+
33+
#### hasSearchSymbolSupport()
34+
35+
Detects if a runtime environment supports ES2015 [`Symbol.search`][mdn-search-symbol].
36+
37+
```javascript
38+
var bool = hasSearchSymbolSupport();
39+
// returns <boolean>
40+
```
41+
42+
</section>
43+
44+
<!-- /.usage -->
45+
46+
<section class="examples">
47+
48+
## Examples
49+
50+
<!-- eslint no-undef: "error" -->
51+
52+
```javascript
53+
var hasSearchSymbolSupport = require( '@stdlib/assert/has-search-symbol-support' );
54+
55+
var bool = hasSearchSymbolSupport();
56+
if ( bool ) {
57+
console.log( 'Environment has Symbol.search support.' );
58+
} else {
59+
console.log( 'Environment lacks Symbol.search support.' );
60+
}
61+
```
62+
63+
</section>
64+
65+
<!-- /.examples -->
66+
67+
* * *
68+
69+
<section class="cli">
70+
71+
## CLI
72+
73+
<section class="usage">
74+
75+
### Usage
76+
77+
```text
78+
Usage: has-search-symbol-support [options]
79+
80+
Options:
81+
82+
-h, --help Print this message.
83+
-V, --version Print the package version.
84+
```
85+
86+
</section>
87+
88+
<!-- /.usage -->
89+
90+
<section class="examples">
91+
92+
### Examples
93+
94+
```bash
95+
$ has-search-symbol-support
96+
<boolean>
97+
```
98+
99+
</section>
100+
101+
<!-- /.examples -->
102+
103+
</section>
104+
105+
<!-- /.cli -->
106+
107+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
108+
109+
<section class="related">
110+
111+
</section>
112+
113+
<!-- /.related -->
114+
115+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
116+
117+
<section class="links">
118+
119+
[mdn-search-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/search
120+
121+
</section>
122+
123+
<!-- /.links -->

‎has-search-symbol-support/benchmark/benchmark.js‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var isBoolean = require( './../../is-boolean' ).isPrimitive;
25+
var pkg = require( './../package.json' ).name;
26+
var hasSearchSymbolSupport = require( './../lib' );
27+
28+
29+
// MAIN //
30+
31+
bench( pkg, function benchmark( b ) {
32+
var bool;
33+
var i;
34+
35+
b.tic();
36+
for ( i = 0; i < b.iterations; i++ ) {
37+
// Note: the following *could* be optimized away via loop-invariant code motion. If so, the entire loop will disappear.
38+
bool = hasSearchSymbolSupport();
39+
if ( typeof bool !== 'boolean' ) {
40+
b.fail( 'should return a boolean' );
41+
}
42+
}
43+
b.toc();
44+
if ( !isBoolean( bool ) ) {
45+
b.fail( 'should return a boolean' );
46+
}
47+
b.pass( 'benchmark finished' );
48+
b.end();
49+
});

‎has-search-symbol-support/bin/cli‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
#!/usr/bin/env node
2+
3+
/**
4+
* @license Apache-2.0
5+
*
6+
* Copyright (c) 2025 The Stdlib Authors.
7+
*
8+
* Licensed under the Apache License, Version 2.0 (the "License");
9+
* you may not use this file except in compliance with the License.
10+
* You may obtain a copy of the License at
11+
*
12+
* http://www.apache.org/licenses/LICENSE-2.0
13+
*
14+
* Unless required by applicable law or agreed to in writing, software
15+
* distributed under the License is distributed on an "AS IS" BASIS,
16+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17+
* See the License for the specific language governing permissions and
18+
* limitations under the License.
19+
*/
20+
21+
'use strict';
22+
23+
// MODULES //
24+
25+
var resolve = require( 'path' ).resolve;
26+
var readFileSync = require( '@stdlib/fs/read-file' ).sync;
27+
var CLI = require( '@stdlib/cli/ctor' );
28+
var detect = require( './../lib' );
29+
30+
31+
// MAIN //
32+
33+
/**
34+
* Main execution sequence.
35+
*
36+
* @private
37+
*/
38+
function main() {
39+
var flags;
40+
var cli;
41+
42+
// Create a command-line interface:
43+
cli = new CLI({
44+
'pkg': require( './../package.json' ),
45+
'options': require( './../etc/cli_opts.json' ),
46+
'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
47+
'encoding': 'utf8'
48+
})
49+
});
50+
51+
// Get any provided command-line options:
52+
flags = cli.flags();
53+
if ( flags.help || flags.version ) {
54+
return;
55+
}
56+
57+
console.log( detect() ); // eslint-disable-line no-console
58+
}
59+
60+
main();

‎has-search-symbol-support/docs/repl.txt‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
{{alias}}()
3+
Tests for native `Symbol.search` support.
4+
5+
Returns
6+
-------
7+
bool: boolean
8+
Boolean indicating if an environment has native `Symbol.search`
9+
support.
10+
11+
Examples
12+
--------
13+
> var bool = {{alias}}()
14+
<boolean>
15+
16+
See Also
17+
--------
18+

‎has-search-symbol-support/docs/types/index.d.ts‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Tests for native `Symbol.search` support.
23+
*
24+
* @returns boolean indicating if an environment has `Symbol.search` support
25+
*
26+
* @example
27+
* var bool = hasSearchSymbolSupport();
28+
* // returns <boolean>
29+
*/
30+
declare function hasSearchSymbolSupport(): boolean;
31+
32+
33+
// EXPORTS //
34+
35+
export = hasSearchSymbolSupport;

‎has-search-symbol-support/docs/types/test.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 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+
import hasSearchSymbolSupport = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The function returns a boolean...
25+
{
26+
hasSearchSymbolSupport();// $ExpectType boolean
27+
}
28+
29+
// The compiler throws an error if the function is provided arguments...
30+
{
31+
hasSearchSymbolSupport( true ); // $ExpectError
32+
hasSearchSymbolSupport( [], 123 ); // $ExpectError
33+
}

‎has-search-symbol-support/docs/usage.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
2+
Usage: has-search-symbol-support [options]
3+
4+
Options:
5+
6+
-h, --help Print this message.
7+
-V, --version Print the package version.

‎has-search-symbol-support/etc/cli_opts.json‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"boolean": [
3+
"help",
4+
"version"
5+
],
6+
"alias": {
7+
"help": [
8+
"h"
9+
],
10+
"version": [
11+
"V"
12+
]
13+
}
14+
}

0 commit comments

Comments
 (0)