From d4fb36e93d56e768375de8f23b56a27b4d6a315f Mon Sep 17 00:00:00 2001 From: 12adarshkumar12 <12adarshkumar12@gmail.com> Date: Wed, 19 Nov 2025 18:01:06 +0530 Subject: [PATCH] Added new symbol split --- .../@stdlib/symbol/split/README.md | 130 ++++++++++++++++++ .../@stdlib/symbol/split/docs/repl.txt | 16 +++ .../symbol/split/docs/types/index.d.ts | 31 +++++ .../@stdlib/symbol/split/docs/types/test.ts | 29 ++++ .../@stdlib/symbol/split/examples/index.js | 42 ++++++ .../@stdlib/symbol/split/lib/index.js | 44 ++++++ .../@stdlib/symbol/split/lib/main.js | 48 +++++++ .../@stdlib/symbol/split/package.json | 57 ++++++++ .../@stdlib/symbol/split/test/test.js | 52 +++++++ 9 files changed, 449 insertions(+) create mode 100644 lib/node_modules/@stdlib/symbol/split/README.md create mode 100644 lib/node_modules/@stdlib/symbol/split/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/symbol/split/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/symbol/split/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/symbol/split/examples/index.js create mode 100644 lib/node_modules/@stdlib/symbol/split/lib/index.js create mode 100644 lib/node_modules/@stdlib/symbol/split/lib/main.js create mode 100644 lib/node_modules/@stdlib/symbol/split/package.json create mode 100644 lib/node_modules/@stdlib/symbol/split/test/test.js diff --git a/lib/node_modules/@stdlib/symbol/split/README.md b/lib/node_modules/@stdlib/symbol/split/README.md new file mode 100644 index 000000000000..561c27c18c35 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/README.md @@ -0,0 +1,130 @@ + + +# SplitSymbol + +> [Symbol][mdn-symbol] which provides a method for splitting strings using the current object as the separator. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var SplitSymbol = require( '@stdlib/symbol/split' ); +``` + +### SplitSymbol + +[`Symbol`][mdn-symbol] which provides a method for splitting strings using the current object as the separator. + +```javascript +var s = typeof SplitSymbol; +// 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`. +- When calling `String.prototype.split` and the `separator` argument is an object with a `[SplitSymbol]()` method, this method is called with the target string and a limit as arguments, and its result is used as the returned array of substrings. If the `[SplitSymbol]` property is `null` or `absent`, the default splitting behavior is used. + +
+ + + + + +
+ +## Examples + + + +```javascript +var defineProperty = require( '@stdlib/utils/define-property' ); +var SplitSymbol = require( '@stdlib/symbol/split' ); + +function split( str ) { + return [ str, 'CUSTOM' ]; +} + +var obj = {}; + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': null +}); + +var str = 'a-b-c'; +console.log( str.split( obj ) ); + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': split +}); +console.log( str.split( obj ) ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol + +
+ + diff --git a/lib/node_modules/@stdlib/symbol/split/docs/repl.txt b/lib/node_modules/@stdlib/symbol/split/docs/repl.txt new file mode 100644 index 000000000000..34c7e5caa13b --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/docs/repl.txt @@ -0,0 +1,16 @@ +{{alias}} + Split symbol. + + This symbol provides a method for splitting strings using the current + object as the separator. + + 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/split/docs/types/index.d.ts b/lib/node_modules/@stdlib/symbol/split/docs/types/index.d.ts new file mode 100644 index 000000000000..44e80be79fcf --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/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 // + +/** +* Split symbol. +* +* ## Notes +* +* - This symbol provides a method for splitting strings using the current object as the separator. +* - The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`. +*/ +export = Symbol.split; diff --git a/lib/node_modules/@stdlib/symbol/split/docs/types/test.ts b/lib/node_modules/@stdlib/symbol/split/docs/types/test.ts new file mode 100644 index 000000000000..e667a495283a --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/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 SplitSymbol = require( './index' ); + + +// TESTS // + +// The exported value is the `replace` symbol... +{ + SplitSymbol; +} diff --git a/lib/node_modules/@stdlib/symbol/split/examples/index.js b/lib/node_modules/@stdlib/symbol/split/examples/index.js new file mode 100644 index 000000000000..305c58616183 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/examples/index.js @@ -0,0 +1,42 @@ +/** +* @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 defineProperty = require( '@stdlib/utils/define-property' ); +var SplitSymbol = require( './../lib' ); + +function split( str ) { + return [ str, 'CUSTOM' ]; +} + +var obj = {}; + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': null +}); + +var str = 'a-b-c'; +console.log( str.split( obj ) ); + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': split +}); +console.log( str.split( obj ) ); diff --git a/lib/node_modules/@stdlib/symbol/split/lib/index.js b/lib/node_modules/@stdlib/symbol/split/lib/index.js new file mode 100644 index 000000000000..6ec38001b2af --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/lib/index.js @@ -0,0 +1,44 @@ +/** +* @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 which provides a method for replacing substrings matched by the current object. +* +* @module @stdlib/symbol/split +* +* @example +* var SplitSymbol = require( '@stdlib/symbol/split' ); +* +* function split( str ) { +* return [ str, 'CUSTOM' ]; +* } +* +* var obj = {}; +* obj[ SplitSymbol ] = split; +*/ + +// MAIN // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/symbol/split/lib/main.js b/lib/node_modules/@stdlib/symbol/split/lib/main.js new file mode 100644 index 000000000000..fa27e6b83c9d --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/lib/main.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'; + +// MODULES // + +var hasSplitSymbolSupport = require( '@stdlib/assert/has-split-symbol-support' ); + + +// MAIN // + +/** +* Split symbol. +* +* @name SplitSymbol +* @constant +* @type {(symbol|null)} +* +* @example +* function split( str ) { +* return [ str, 'CUSTOM' ]; +* } +* +* var obj = {}; +* obj[ SplitSymbol ] = split; +*/ +var SplitSymbol = ( hasSplitSymbolSupport() ) ? Symbol.split : null; + + +// EXPORTS // + +module.exports = SplitSymbol; diff --git a/lib/node_modules/@stdlib/symbol/split/package.json b/lib/node_modules/@stdlib/symbol/split/package.json new file mode 100644 index 000000000000..33ab63ed2d7b --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/package.json @@ -0,0 +1,57 @@ +{ + "name": "@stdlib/symbol/split", + "version": "0.0.0", + "description": "Split 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", + "spl", + "string", + "split" + ] +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/symbol/split/test/test.js b/lib/node_modules/@stdlib/symbol/split/test/test.js new file mode 100644 index 000000000000..a2b001b343f6 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/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 hasSplitSymbolSupport = require( '@stdlib/assert/has-split-symbol-support' ); +var isSymbol = require( '@stdlib/assert/is-symbol' ); +var Sym = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': !hasSplitSymbolSupport() +}; + + +// 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.split`', opts, function test( t ) { + t.strictEqual( Sym, Symbol.split, 'returns expected value' ); + t.end(); +}); \ No newline at end of file