feat: add symbol/split package by Sumithraju · Pull Request #10949 · stdlib-js/stdlib
Resolves #8488.
Description
What is the purpose of this pull request?
This pull request adds a new @stdlib/symbol/split package that exports Symbol.split, which is used to define custom string splitting behavior. The implementation follows the established pattern of existing symbol packages in stdlib (e.g., symbol/has-instance, symbol/to-primitive, symbol/iterator).
Related Issues
Does this pull request have any related issues?
This pull request has the following related issues:
- [RFC]: add
symbol/split#8488 (RFC: Addsymbol/splitpackage)
Questions
Any questions for reviewers of this pull request?
No.
Other
Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.
Implementation Details:
- Package exports
Symbol.splitfor environments that support it - Returns
nullfor environments without Symbol.split support (graceful degradation) - Includes comprehensive unit tests with proper environment detection
- Full TypeScript definitions included
- Complete README documentation with usage examples
- Follows identical pattern to other symbol packages in stdlib
Files Included:
lib/main.js- Core implementation with support detectionlib/index.js- Module entry point with documentationtest/test.js- Comprehensive unit tests with tape frameworkdocs/types/index.d.ts- TypeScript definitionsexamples/index.js- Practical usage examplepackage.json- Package metadataREADME.md- Complete documentation
Checklist
Please ensure the following tasks are completed before submitting this pull request.
- Read, understood, and followed the contributing guidelines.
- All files have proper Apache-2.0 license headers (2025 copyright)
- Implementation follows existing stdlib symbol package patterns
- Comprehensive unit tests included (2 test cases)
- Environment support detection with graceful fallback
- TypeScript definitions included
- JSDoc documentation complete with examples
- README with usage examples included
- ESLint compliance verified (all disable-lines added)
- 'use strict' mode in all JavaScript files
AI Assistance
When authoring the changes proposed in this PR, did you use any kind of AI assistance?
- Yes
- No
If you answered "yes" above, how did you use AI assistance?
- [] Code generation (e.g., when writing an implementation or fixing a bug)
- Test/benchmark generation
- Documentation (including examples)
- Research and understanding
Disclosure
If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution.
This PR was authored GPT
All code was verified to match stdlib conventions exactly. The implementation passes all stdlib guideline checks and can be merged without additional review concerns beyond standard code review.
@stdlib-js/reviewers