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..45a457c507a0 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/README.md @@ -0,0 +1,135 @@ + + +# SearchSymbol + +> [`Symbol.search`][mdn-symbol-search], which specifies the method used by [`String.prototype.search()`][mdn-string-search] to match a regular expression or a custom object. + +
+ +The `Symbol.search` symbol allows objects to define custom search behavior when used with the built-in `String.prototype.search()` method. + +
+ +
+ +## Usage + +```javascript +var SearchSymbol = require( '@stdlib/symbol/search' ); +``` + +#### SearchSymbol + +[`symbol`][mdn-symbol] which specifies the method used by `String.prototype.search()` to determine how a string is searched. +Objects that define a `[Symbol.search]` method can customize their own search behavior. + +```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' ); + +/** +* Constructor for creating search objects. +* +* @param {string} value - search value +* @returns {Search} search instance +*/ +function Search( value ) { + if ( !(this instanceof Search) ) { + return new Search( value ); + } + this.value = value; +} + +/** +* Implement `Symbol.search`. +* +* @param {string} str - input string +* @returns {integer} match index +*/ +function searchMethod( str ) { + return str.indexOf( this.value ); +} + +Search.prototype[ SearchSymbol ] = searchMethod; + +console.log( 'foobar'.search( new Search( 'bar' ) ) ); +// => 3 +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol +[mdn-symbol-search]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/search +[mdn-string-search]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/search + +
+ + 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..a10e29181cf3 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/docs/repl.txt @@ -0,0 +1,18 @@ + +{{alias}} + Search symbol. + + This symbol specifies whether an array-like object should be flattened to + its elements during concatenation. + + 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..760f793614bc --- /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 specifies the method used by `String.prototype.search()`. +* - Objects defining a `[Symbol.search]` method can customize how they are searched within a string. +*/ +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..3369a979996d --- /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..cb00f899fe78 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/examples/index.js @@ -0,0 +1,43 @@ +/** +* @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 SearchSymbol = require( './../lib' ); + +// MAIN // + +/** +* Example demonstrating the use of Symbol.search. +*/ +function Search( value ) { + if ( !(this instanceof Search) ) { + return new Search( value ); + } + this.value = value; +} + +Search.prototype[ SearchSymbol ] = function search( str ) { + return str.indexOf( this.value ); +}; + +// EXPORTS // + +console.log( 'foobar'.search( new Search( 'bar' ) ) ); 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..6c1b95b21b2a --- /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'; + +/** +* Search symbol. +* +* @module @stdlib/symbol/search +* +* @example +* // eslint-disable stdlib/jsdoc-doctest +* var SearchSymbol = require( '@stdlib/symbol/search' ); +* +* class Search { +* constructor( value ) { +* this.value = value; +* } +* [ SearchSymbol ]( string ) { +* return string.indexOf( this.value ); +* } +* } +* +* console.log( 'foobar'.search( new Search( 'bar' ) ) ); +* // => 3 +* // eslint-enable stdlib/jsdoc-doctest +*/ + + +// 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..de789a47f9cf --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/lib/main.js @@ -0,0 +1,54 @@ +/** +* @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' ); +var Symbol = require( '@stdlib/symbol/ctor' ); + + +// MAIN // + +/** +* Symbol which specifies the method to match against a string. +* +* @constant +* @type {(symbol|null)} +* +* @example +* class SearchSymbolExample { +* constructor( value ) { +* this.value = value; +* } +* [ SearchSymbol ]( str ) { +* return str.indexOf( this.value ); +* } +* } +* +* console.log( 'foobar'.search( new SearchSymbolExample( 'bar' ) ) ); +* // => 3 +*/ + +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..714cca20b09a --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/search/package.json @@ -0,0 +1,61 @@ +{ + "name": "@stdlib/symbol/search", + "version": "0.0.0", + "description": "Search 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", + "search", + "string", + "regexp", + "match", + "custom", + "behavior" + ] +} 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..ec8972e5a634 --- /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' ); // eslint-disable-line id-length +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(); +});