From b23fccea73325acb66dc9143cdf67bfad9492dcb Mon Sep 17 00:00:00 2001 From: sagar7162 Date: Thu, 13 Nov 2025 19:39:37 +0530 Subject: [PATCH 1/4] feat: add symbol/search --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../@stdlib/symbol/search/README.md | 136 ++++++++++++++++++ .../@stdlib/symbol/search/docs/repl.txt | 18 +++ .../symbol/search/docs/types/index.d.ts | 31 ++++ .../@stdlib/symbol/search/docs/types/test.ts | 29 ++++ .../@stdlib/symbol/search/examples/index.js | 48 +++++++ .../@stdlib/symbol/search/lib/index.js | 52 +++++++ .../@stdlib/symbol/search/lib/main.js | 58 ++++++++ .../@stdlib/symbol/search/package.json | 57 ++++++++ .../@stdlib/symbol/search/test/test.js | 52 +++++++ 9 files changed, 481 insertions(+) create mode 100644 lib/node_modules/@stdlib/symbol/search/README.md create mode 100644 lib/node_modules/@stdlib/symbol/search/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/symbol/search/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/symbol/search/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/symbol/search/examples/index.js create mode 100644 lib/node_modules/@stdlib/symbol/search/lib/index.js create mode 100644 lib/node_modules/@stdlib/symbol/search/lib/main.js create mode 100644 lib/node_modules/@stdlib/symbol/search/package.json create mode 100644 lib/node_modules/@stdlib/symbol/search/test/test.js diff --git a/lib/node_modules/@stdlib/symbol/search/README.md b/lib/node_modules/@stdlib/symbol/search/README.md new file mode 100644 index 000000000000..a8c0524a9f74 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/README.md @@ -0,0 +1,136 @@ + + +# SearchSymbol + +> Search [symbol][mdn-symbol] used to used to determine the index within a string that matches the current object. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var SearchSymbol = require( '@stdlib/symbol/search' ); +``` + +#### SearchSymbol + +Search [`symbol`][mdn-symbol] which is used to determine the index within a string that matches the current object. + +```javascript +var s = typeof SearchSymbol; +// e.g., returns 'symbol' +``` + +
+ + + + + +
+ +## Notes + +- The [symbol][mdn-symbol] is only supported in environments which support [symbols][mdn-symbol]. In non-supporting environments, the value is `null`. + +
+ + + + + +
+ +## Examples + + + +```javascript +var SearchSymbol = require( '@stdlib/symbol/search' ); + +function searcher() { + var obj = {}; + + if ( SearchSymbol ) { + // Define custom search behavior: + obj[ SearchSymbol ] = search; + } + return obj; +} + +function search( str ) { + // Return the index of substring 'foo': + return str.indexOf( 'foo' ); +} + +var obj = searcher(); +var str = 'foobar'; +var result = str.search( obj ); + +console.log( result ); +// => 0 + +str = 'barfoo'; +result = str.search( obj ); + +console.log( result ); +// => 3 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol + +
+ + diff --git a/lib/node_modules/@stdlib/symbol/search/docs/repl.txt b/lib/node_modules/@stdlib/symbol/search/docs/repl.txt new file mode 100644 index 000000000000..c7171d0dc40d --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/docs/repl.txt @@ -0,0 +1,18 @@ + +{{alias}} + Has instance symbol. + + This symbol is used to determine whether a constructor object recognizes an + object as its instance. + + The symbol is only supported in ES6/ES2015+ environments. For non-supporting + environments, the value is `null`. + + Examples + -------- + > var s = {{alias}} + e.g., + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/symbol/search/docs/types/index.d.ts b/lib/node_modules/@stdlib/symbol/search/docs/types/index.d.ts new file mode 100644 index 000000000000..e2419a576c4f --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/docs/types/index.d.ts @@ -0,0 +1,31 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +// EXPORTS // + +/** +* Search symbol. +* +* ## Notes +* +* - This symbol is used to determine the index within a string that matches the current object. +* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`. +*/ +export = Symbol.search; diff --git a/lib/node_modules/@stdlib/symbol/search/docs/types/test.ts b/lib/node_modules/@stdlib/symbol/search/docs/types/test.ts new file mode 100644 index 000000000000..59ca66ebe8a2 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/docs/types/test.ts @@ -0,0 +1,29 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +/* eslint-disable @typescript-eslint/no-unused-expressions */ + +import Search = require( './index' ); + + +// TESTS // + +// The exported value is the `search` symbol... +{ + Search; +} diff --git a/lib/node_modules/@stdlib/symbol/search/examples/index.js b/lib/node_modules/@stdlib/symbol/search/examples/index.js new file mode 100644 index 000000000000..a6c88ef2e6d9 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/examples/index.js @@ -0,0 +1,48 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var SearchSymbol = require( './../lib' ); + +function searcher() { + var obj = {}; + + if ( SearchSymbol ) { + // Define custom search behavior: + obj[ SearchSymbol ] = search; + } + return obj; +} + +function search( str ) { + // Return the index of substring 'foo': + return str.indexOf( 'foo' ); +} + +var obj = searcher(); +var str = 'foobar'; +var result = str.search( obj ); + +console.log( result ); +// => 0 + +str = 'barfoo'; +result = str.search( obj ); + +console.log( result ); diff --git a/lib/node_modules/@stdlib/symbol/search/lib/index.js b/lib/node_modules/@stdlib/symbol/search/lib/index.js new file mode 100644 index 000000000000..e1de8e2128a4 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/lib/index.js @@ -0,0 +1,52 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Symbol used to determine the index within a string that matches the current object. +* +* @module @stdlib/symbol/search +* +* @example +* var SearchSymbol = require( '@stdlib/symbol/search' ); +* +* function searcher() { +* var obj = {}; +* obj[ SearchSymbol ] = function search( str ) { +* // Return the index of substring 'foo': +* return str.indexOf( 'foo' ); +* }; +* return obj; +* } +* +* var obj = searcher(); +* var str = 'foobar'; +* +* var result = str.search( obj ); +* // returns 0 +*/ + +// MAIN // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/symbol/search/lib/main.js b/lib/node_modules/@stdlib/symbol/search/lib/main.js new file mode 100644 index 000000000000..177555cf8a0b --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/lib/main.js @@ -0,0 +1,58 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var hasSearchSymbolSupport = require( '@stdlib/assert/has-search-symbol-support' ); + + +// MAIN // + +/** +* Has instance symbol. +* +* @name SearchSymbol +* @constant +* @type {(symbol|null)} +* +* @example +* var SearchSymbol = require( '@stdlib/symbol/search' ); +* +* function searcher() { +* var obj = {}; +* obj[ SearchSymbol ] = function search( str ) { +* // Return the index of substring 'foo': +* return str.indexOf( 'foo' ); +* }; +* return obj; +* } +* +* var obj = searcher(); +* var str = 'foobar'; +* +* var result = str.search( obj ); +* // returns 0 +*/ +var SearchSymbol = ( hasSearchSymbolSupport() ) ? Symbol.search : null; + + +// EXPORTS // + +module.exports = SearchSymbol; diff --git a/lib/node_modules/@stdlib/symbol/search/package.json b/lib/node_modules/@stdlib/symbol/search/package.json new file mode 100644 index 000000000000..0edb90437fbc --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/package.json @@ -0,0 +1,57 @@ +{ + "name": "@stdlib/symbol/search", + "version": "0.0.0", + "description": "Has instance symbol.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "symbol", + "sym", + "instance", + "instanceof" + ] +} diff --git a/lib/node_modules/@stdlib/symbol/search/test/test.js b/lib/node_modules/@stdlib/symbol/search/test/test.js new file mode 100644 index 000000000000..7fd28478c487 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/test/test.js @@ -0,0 +1,52 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var hasSearchSymbolSupport = require( '@stdlib/assert/has-search-symbol-support' ); +var isSymbol = require( '@stdlib/assert/is-symbol' ); +var Sym = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasSearchSymbolSupport() +}; + + +// TESTS // + +tape( 'main export is a symbol in supporting environments (ES6/2015+) or otherwise null', function test( t ) { + t.ok( true, __filename ); + if ( opts.skip ) { + t.strictEqual( Sym, null, 'main export is null' ); + } else { + t.strictEqual( typeof Sym, 'symbol', 'main export is a symbol' ); + t.strictEqual( isSymbol( Sym ), true, 'main export is a symbol' ); + } + t.end(); +}); + +tape( 'the main export is an alias for `Symbol.search`', opts, function test( t ) { + t.strictEqual( Sym, Symbol.search, 'returns expected value' ); + t.end(); +}); From 95d2c5f23e46779ce90a15353f5f40f4eaad74fb Mon Sep 17 00:00:00 2001 From: Sagar Ratna Chaudhary <161244282+sagar7162@users.noreply.github.com> Date: Tue, 18 Nov 2025 14:41:59 +0530 Subject: [PATCH 2/4] Apply suggestion from @kgryte Co-authored-by: Athan Signed-off-by: Sagar Ratna Chaudhary <161244282+sagar7162@users.noreply.github.com> --- lib/node_modules/@stdlib/symbol/search/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/node_modules/@stdlib/symbol/search/README.md b/lib/node_modules/@stdlib/symbol/search/README.md index a8c0524a9f74..b45fc821e073 100644 --- a/lib/node_modules/@stdlib/symbol/search/README.md +++ b/lib/node_modules/@stdlib/symbol/search/README.md @@ -20,7 +20,7 @@ limitations under the License. # SearchSymbol -> Search [symbol][mdn-symbol] used to used to determine the index within a string that matches the current object. +> Search [symbol][mdn-symbol] which is used to determine the index within a string that matches the current object. From 9b8d4cf8227b7bedbcbd3f73ecc56daa6b70527b Mon Sep 17 00:00:00 2001 From: Sagar Ratna Chaudhary <161244282+sagar7162@users.noreply.github.com> Date: Tue, 18 Nov 2025 14:44:56 +0530 Subject: [PATCH 3/4] Revise repl.txt to update instance symbol description Updated documentation for the instance symbol to clarify its purpose and usage. Signed-off-by: Sagar Ratna Chaudhary <161244282+sagar7162@users.noreply.github.com> --- lib/node_modules/@stdlib/symbol/search/docs/repl.txt | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/symbol/search/docs/repl.txt b/lib/node_modules/@stdlib/symbol/search/docs/repl.txt index c7171d0dc40d..23c464dea163 100644 --- a/lib/node_modules/@stdlib/symbol/search/docs/repl.txt +++ b/lib/node_modules/@stdlib/symbol/search/docs/repl.txt @@ -1,9 +1,9 @@ {{alias}} - Has instance symbol. + Search symbol. - This symbol is used to determine whether a constructor object recognizes an - object as its instance. + This symbol is used to determine the index within a string + that matches the current object. The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`. @@ -15,4 +15,3 @@ See Also -------- - From d64e753fbbc40b28bde4663b481d46b71adb2b69 Mon Sep 17 00:00:00 2001 From: Sagar Ratna Chaudhary <161244282+sagar7162@users.noreply.github.com> Date: Tue, 18 Nov 2025 14:46:19 +0530 Subject: [PATCH 4/4] Update package description and keywords Signed-off-by: Sagar Ratna Chaudhary <161244282+sagar7162@users.noreply.github.com> --- lib/node_modules/@stdlib/symbol/search/package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/symbol/search/package.json b/lib/node_modules/@stdlib/symbol/search/package.json index 0edb90437fbc..b670e4c4c34a 100644 --- a/lib/node_modules/@stdlib/symbol/search/package.json +++ b/lib/node_modules/@stdlib/symbol/search/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/symbol/search", "version": "0.0.0", - "description": "Has instance symbol.", + "description": "Search symbol.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -51,7 +51,7 @@ "stdlib", "symbol", "sym", - "instance", - "instanceof" + "search", + "string" ] }