From adbbff032263fa31133af6d015e3da33ba9a7a87 Mon Sep 17 00:00:00 2001 From: Diyan Date: Mon, 23 Feb 2026 22:41:07 +0530 Subject: [PATCH] feat:added symbol/split --- .../@stdlib/symbol/split/README.md | 138 ++++++++++++++++++ .../@stdlib/symbol/split/docs/repl.txt | 17 +++ .../symbol/split/docs/types/index.d.ts | 31 ++++ .../@stdlib/symbol/split/docs/types/test.ts | 29 ++++ .../@stdlib/symbol/split/examples/index.js | 44 ++++++ .../@stdlib/symbol/split/lib/index.js | 43 ++++++ .../@stdlib/symbol/split/lib/main.js | 47 ++++++ .../@stdlib/symbol/split/package.json | 56 +++++++ .../@stdlib/symbol/split/test/test.js | 52 +++++++ 9 files changed, 457 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..3a88057ce18c --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/README.md @@ -0,0 +1,138 @@ + + +# SplitSymbol + +> Split [symbol][mdn-split-symbol] which is used to split a string at the indices that match the current object. + + + +
+ +
+ + + + + +
+ +## Usage + +```javascript +var SplitSymbol = require( '@stdlib/symbol/split' ); +``` + +#### SplitSymbol + +Split [`symbol`][mdn-split-symbol] which is used to split a string at the indices that match the current object. + +```javascript +var s = typeof SplitSymbol; +// e.g., returns 'symbol' +``` + +
+ + + + + +
+ +## Notes + +- This [symbol][mdn-split-symbol] is only supported in environments which support [symbols][mdn-symbol]. In non-supporting environments, the value is `null`. + +- The `split` operator uses the following algorithm to determine the return value of `string.split( object )`: + + - If `object` has `[SplitSymbol]()` method then the same method is called. + - Otherwise, if `object` does not have a `[SplitSymbol]()` method (i.e., `object[SplitSymbol]` is `null` or `undefined`), the `String.prototype.split()` method determines the result . + +
+ + + + + +
+ +## Examples + + + +```javascript +var defineProperty = require( '@stdlib/utils/define-property' ); +var SplitSymbol = require( './../lib' ); + +function split( str) { + return str.split(" ");> +} + +var obj = {}; + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': null +}); + +var str = 'hello how'; +console.log( str.split( obj ) ); +// => [ 'hello how' ] + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': split +}); +console.log( str.split( obj ) ); +// => [ 'hello', 'how' ] +``` + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + + + +
+ +[mdn-split-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split + +[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symvol + +
+ + 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..87782ab14b48 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/docs/repl.txt @@ -0,0 +1,17 @@ + +{{alias}} + Split symbol. + + This symbol splits a string at the indices that match the current object. + + 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..da3ccc370d46 --- /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 splits a string at the indices that match the current object. +* - 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..b5baf9eb1cbf --- /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 Split = require( './index' ); + + +// TESTS // + +// The exported value is the `split` symbol... +{ + Split; +} 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..5ceb833c2442 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/examples/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'; + +var defineProperty = require( '@stdlib/utils/define-property' ); +var SplitSymbol = require( './../lib' ); + +function split( str) { + return str.split(" "); +} + +var obj = {}; + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': null +}); + +var str = 'hello how'; +console.log( str.split( obj ) ); +// => [ 'hello how' ] + +defineProperty( obj, SplitSymbol, { + 'configurable': true, + 'value': split +}); +console.log( str.split( obj ) ); +// => [ 'hello', 'how' ] 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..1e9259415986 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/lib/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'; + +/** +* Split Symbol +* +* @module @stdlib/symbol/split +* +* @example +* var SplitSymbol = require( '@stdlib/symbol/split' ); +* +* if ( SplitSymbol === null ) { +* console.log( 'Environment does not support Symbol.split.' ); +* } else { +* console.log( 'Environment does support Symbol.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..0c1e621d8dcf --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/lib/main.js @@ -0,0 +1,47 @@ +/** +* @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' ); // eslint-disable-line id-length + + +// MAIN // + +/** +* Split symbol. +* +* @name SplitSymbol +* @constant +* @type {(symbol|null)} +* +* @example +* if ( SplitSymbol === null ) { +* console.log( 'Environment does not support Symbol.split.' ); +* } else { +* console.log( 'Environment does support Symbol.split.' ); +* } +*/ +var SplitSymbol = ( hasSplitSymbolSupport() ) ? Symbol.split : null; // eslint-disable-line max-len + + +// 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..b3a86c5c5813 --- /dev/null +++ b/lib/node_modules/@stdlib/symbol/split/package.json @@ -0,0 +1,56 @@ +{ + "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", + "sym", + "split" + ] +} 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..40b5d475e56c --- /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' ); // eslint-disable-line id-length +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(); +});