feat: add `symbol/match` #8547

kaushal-kumar-it · 2025-11-16T07:50:05Z

Resolves #8478

Description

This pull request adds the new symbol/match package as described in RFC #8478.

The implementation is based on the structure and conventions of the existing symbol packages (e.g., symbol/iterator, symbol/has-instance, etc.). The package exports Symbol.match when available, updates documentation and examples accordingly, and includes the required copyright updates for 2025.

Related Issues

[RFC]: add symbol/match #8478

Questions

No.

Other

No additional notes.

Checklist

Read, understood, and followed the contributing guidelines.

AI Assistance

Yes
No

stdlib-bot · 2025-11-16T07:50:16Z

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

Please read our contributing guidelines.
Update your pull request description to include this checked box:

- [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

The developer's certificate of origin
Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

stdlib-bot · 2025-11-16T07:51:41Z

Coverage Report

Package	Statements	Branches	Functions	Lines
symbol/match	$\color{green}100/100$ $color{green}+100.00%$	$\color{red}2/3$ $color{green}+66.67%$	$\color{green}0/0$ $color{green}+100.00%$	$\color{green}100/100$ $color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

kgryte · 2025-11-18T07:42:39Z

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

+
+# MatchSymbol
+
+> [Symbol][mdn-symbol] which specifies the matching of a regular expression against a string.


Suggested change

> [Symbol][mdn-symbol] which specifies the matching of a regular expression against a string.

> [Symbol][mdn-symbol] which specifies whether an object should be treated as a regular expression.

kgryte · 2025-11-18T07:43:05Z

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

+
+#### MatchSymbol
+
+[`Symbol`][mdn-symbol] which specifies the matching of a regular expression against a string. Used by `String.prototype.match()`.


Suggested change

[`Symbol`][mdn-symbol] which specifies the matching of a regular expression against a string. Used by `String.prototype.match()`.

[`Symbol`][mdn-symbol] which specifies whether an object should be treated as a regular expression.

kgryte · 2025-11-18T07:44:33Z

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

+## Notes
+
+-   The [symbol][mdn-symbol] is only supported in environments which support [symbols][mdn-symbol]. In non-supporting environments, the value is `null`.
+


Describe how MatchSymbol is used here. 1) As a method used by String.prototype.match to match an input string against the current object. This method is provided a single argument: a string. 2) To determine whether an object should be treated as a regular expression.

This is discussed in more depth on MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/match

kgryte · 2025-11-18T07:45:36Z

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

+
+// Default match behavior:
+v = 'football'.match( re );
+console.log( JSON.stringify( v ) );


You don't need JSON.stringify.

kgryte · 2025-11-18T07:46:14Z

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

+{{alias}}
+    Match symbol.
+
+    This symbol specifies the matching of a regular expression against a string.


This should be updated once the README is updated.

kgryte · 2025-11-18T07:46:44Z

lib/node_modules/@stdlib/symbol/match/docs/types/index.d.ts

+*
+* ## Notes
+*
+* -   This symbol specifies the matching of a regular expression against a string. Used by String.prototype.match().


Should be updated once README is updated.

kgryte · 2025-11-18T07:46:54Z

lib/node_modules/@stdlib/symbol/match/docs/types/test.ts

+
+/* eslint-disable @typescript-eslint/no-unused-expressions */
+
+import IsConcatSpreadable = require( './index' );


Copy-paste mistake.

kgryte · 2025-11-18T07:47:07Z

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

+
+// Default match behavior:
+v = 'football'.match( re );
+console.log( JSON.stringify( v ) );


No JSON.stringify.

kgryte · 2025-11-18T07:48:02Z

lib/node_modules/@stdlib/symbol/match/lib/main.js

+* var re = /foo/;
+* var str = 'football';
+*
+* var v = str.match( re );


This example doesn't actually demonstrate symbol.match usage.

kgryte

Left initial comments.

kaushal-kumar-it · 2025-11-18T09:35:35Z

@kgryte All requested changes have been applied. Kindly review when you get a chance.

feat: add symbol/match package

5af296e

stdlib-bot added the Good First PR A pull request resolving a Good First Issue. label Nov 16, 2025

stdlib-bot added the Needs Review A pull request which needs code review. label Nov 16, 2025

kaushal-kumar-it added 6 commits November 16, 2025 13:30

feat: add symbol/match package

c0500a8

feat: add symbol/match package

d697130

Fix symbol/match examples and use JSON.stringify for array output

53451cd

Fix symbol/match examples and use JSON.stringify for array output

8dc8422

Remove unused parameter in customMatch function

17c22fd

Remove unused parameter in customMatch function

871e4bc

kgryte changed the title ~~feat: add symbol/match package~~ feat: add symbol/match Nov 18, 2025

kgryte added Feature Issue or pull request for adding a new feature. and removed Needs Review A pull request which needs code review. labels Nov 18, 2025

kgryte reviewed Nov 18, 2025

View reviewed changes

kgryte requested changes Nov 18, 2025

View reviewed changes

kgryte added the Needs Changes Pull request which needs changes before being merged. label Nov 18, 2025

kaushal-kumar-it added 5 commits November 18, 2025 14:17

fixed Copy-paste mistake

854a7ae

corrected notes of readme file

35cc300

corrected notes of readme file

e6235db

corrected index.d.ts file

cf3dac8

fixed json and wrong example

5e9fb15

kaushal-kumar-it added 2 commits November 18, 2025 14:57

fixed repl.txt

7546e28

fixed lint eror

35fc564


		# MatchSymbol

		> [Symbol][mdn-symbol] which specifies the matching of a regular expression against a string.

	> [Symbol][mdn-symbol] which specifies the matching of a regular expression against a string.
	> [Symbol][mdn-symbol] which specifies whether an object should be treated as a regular expression.


		#### MatchSymbol

		[`Symbol`][mdn-symbol] which specifies the matching of a regular expression against a string. Used by `String.prototype.match()`.

	[`Symbol`][mdn-symbol] which specifies the matching of a regular expression against a string. Used by `String.prototype.match()`.
	[`Symbol`][mdn-symbol] which specifies whether an object should be treated as a regular expression.

		## Notes

		- The [symbol][mdn-symbol] is only supported in environments which support [symbols][mdn-symbol]. In non-supporting environments, the value is `null`.


		/* eslint-disable @typescript-eslint/no-unused-expressions */

		import IsConcatSpreadable = require( './index' );

Uh oh!

feat: add symbol/match #8547

Are you sure you want to change the base?

feat: add symbol/match #8547

Uh oh!

Conversation

kaushal-kumar-it commented Nov 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Uh oh!

stdlib-bot commented Nov 16, 2025

Uh oh!

stdlib-bot commented Nov 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

kaushal-kumar-it commented Nov 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `symbol/match` #8547

feat: add `symbol/match` #8547

kaushal-kumar-it commented Nov 16, 2025 •

edited

Loading

stdlib-bot commented Nov 16, 2025 •

edited

Loading