feat: add symbol/split

lib/node_modules/@stdlib/symbol/split/README.md

@@ -0,0 +1,150 @@
+<!--
+
+@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.
+
+-->
+
+# SplitSymbol
+
+> Split [symbol][mdn-symbol] which specifies the default split for an object.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var SplitSymbol = require( '@stdlib/symbol/split' );
+```
+
+#### SplitSymbol
+
+Split [`symbol`][mdn-symbol] which specifies the default split for an object.
+
+```javascript
+var s = typeof SplitSymbol;
+// e.g., returns 'symbol'
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   The [symbol][mdn-symbol] is only supported in environments which support [symbols][mdn-symbol]. In non-supporting environments, the value is `null`.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var SplitSymbol = require( '@stdlib/symbol/split' );
+var trim = require( '@stdlib/string/trim' );
+
+/**
+* Splits a comma-separated string and trims each part.
+*
+* @private
+* @param {string} str - input string
+* @returns {Array<string>} parts
+*/
+function split( str ) {
+    // Split by commas and trim spaces:
+    return str.split( ',' ).map( ( part ) => trim( part ) );
+}
+
+function splitter() {
+    var obj = {};
+
+    if ( SplitSymbol ) {
+        // Define how to split a string when used with String.prototype.split
+        obj[ SplitSymbol ] = split;
+    }
+    return obj;
+}
+
+// Example usage:
+var obj = splitter();
+var result = 'apple, banana, cherry'.split( obj );
+
+console.log( result );
+// => [ 'apple', 'banana', 'cherry' ]
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/symbol/ctor`][@stdlib/symbol/ctor]</span><span class="delimiter">: </span><span class="description">symbols.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
+
+<!-- <related-links> -->
+
+[@stdlib/symbol/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/symbol/ctor
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/symbol/split/docs/repl.txt

@@ -0,0 +1,16 @@
+
+{{alias}}
+    Split symbol.
+
+    This symbol specifies the default split for an object.
+
+    The symbol is only supported in ES6/ES2015+ environments. For non-supporting
+    environments, the value is `null`.
+
+    Examples
+    --------
+    > var s = {{alias}};
+
+    See Also
+    --------
+

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 specifies the default split for an object.
+* -   The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
+*/
+export = Symbol.split;

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 split symbol...
+{
+	SplitSymbol;
+}

lib/node_modules/@stdlib/symbol/split/examples/index.js

@@ -0,0 +1,53 @@
+/**
+* @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 SplitSymbol = require( '@stdlib/symbol/split' );
+var trim = require( '@stdlib/string/trim' );
+
+/**
+* Splits a comma-separated string and trims each part.
+*
+* @private
+* @param {string} str - input string
+* @returns {Array<string>} parts
+*/
+function split( str ) {
+	return str.split( ',' ).map( ( part ) => trim( part ) );
+}
+
+/**
+* Returns an object implementing the split symbol.
+*
+* @returns {Object} object with custom split method
+*/
+function splitter() {
+	var obj = {};
+
+	if ( SplitSymbol ) {
+		obj[ SplitSymbol ] = split;
+	}
+	return obj;
+}
+
+// Example usage:
+var obj = splitter();
+var result = 'apple, banana, cherry'.split( obj );
+console.log( result );
+// => [ 'apple', 'banana', 'cherry' ]

lib/node_modules/@stdlib/symbol/split/lib/index.js

@@ -0,0 +1,60 @@
+/**
+* @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
+function splitter() {
+*     var obj;
+*
+*     obj = {};
+*
+*     var splitSymbol = require( '@stdlib/symbol/split' );
+*
+*     if ( splitSymbol ) {
+*         obj[ splitSymbol ] = split;
+*     }
+*     return obj;
+*
+*     function split( str ) {
+*         // Split by commas and trim each part:
+*         return str.split( ',' ).map( function ( part ) {
+*             return part.trim();
+*         });
+*     }
+* }
+*
+* var obj = splitter();
+*
+* var result = 'apple, banana, cherry'.split( obj );
+* // returns [ 'apple', 'banana', 'cherry' ]
+*/
+
+// MAIN //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;