feat: add symbol/match

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

@@ -0,0 +1,143 @@
+<!--
+
+@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.
+
+-->
+
+# MatchSymbol
+
+> Match [symbol][mdn-symbol] which is used to determine if a constructor object recognizes an object as its instance.
+
+<!-- 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 MatchSymbol = require( '@stdlib/symbol/match' );
+```
+
+#### MatchSymbol
+
+Match [`symbol`][mdn-symbol] which is used to determine if a constructor object recognizes an object as its instance.
+
+```javascript
+var s = typeof MatchSymbol;
+// 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`.
+
+-   The `instanceof` operator uses the following algorithm to determine the return value of `object instanceof constructor`:
+
+    -   If `constructor` has a `[MatchSymbol]()` method, the `instanceof` operator calls the method with `object` as the first argument and returns the result (coerced to a boolean). If `constructor` is not an object or if `constructor[MatchSymbol]` is neither `null`, `undefined`, nor a function, the `instanceof` operator raises an exception.
+    -   Otherwise, if `constructor` does not have a `[MatchSymbol]()` method (i.e., `constructor[MatchSymbol]` is `null` or `undefined`), the `instanceof` operator determines the result using the same algorithm as `Function.prototype[MatchSymbol]()`. If `constructor` is not a function, the `instanceof` operator raises an exception.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var isArray = require( '@stdlib/assert/is-array' );
+var instanceOf = require( '@stdlib/assert/instance-of' );
+var defineProperty = require( '@stdlib/utils/define-property' );
+var MatchSymbol = require( '@stdlib/symbol/match' );
+
+function ArrayLike() {
+    return {
+        'length': 3,
+        '0': 4,
+        '1': 5,
+        '2': 6
+    };
+}
+
+function hasInstance( instance ) {
+    return isArray( instance );
+}
+
+var x = [ 1, 2, 3 ];
+
+defineProperty( ArrayLike, MatchSymbol, {
+    'configurable': true,
+    'value': null
+});
+console.log( instanceOf( x, ArrayLike ) );
+
+defineProperty( ArrayLike, MatchSymbol, {
+    'configurable': true,
+    'value': hasInstance
+});
+console.log( instanceOf( x, ArrayLike ) );
+```
+
+</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">
+
+</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
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,19 @@
+{{alias}}
+    Match symbol.
+
+    This symbol specifies the method that retrieves the matches of a string
+    against a regular expression.
+
+    It is used by methods such as `String.prototype.match()` to customize
+    matching behavior.
+
+    The symbol is only supported in ES6/ES2015+ environments. For non-supporting
+    environments, the value is `null`.
+
+    Examples
+    --------
+    > var s = {{alias}}
+    e.g., <symbol>
+
+    See Also
+    --------

lib/node_modules/@stdlib/symbol/match/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 //
+
+/**
+* Match symbol.
+*
+* ## Notes
+*
+* -   This symbol is used to determine whether a constructor object recognizes an object as its instance.
+* -   The symbol is only supported in ES6/ES2015+ environments. For non-supporting environments, the value is `null`.
+*/
+export = Symbol.match;

lib/node_modules/@stdlib/symbol/match/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 Match = require( './index' );
+
+
+// TESTS //
+
+// The exported value is the `match` symbol...
+{
+    Match;
+}

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

@@ -0,0 +1,51 @@
+/**
+* @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 isArray = require( '@stdlib/assert/is-array' );
+var instanceOf = require( '@stdlib/assert/instance-of' );
+var defineProperty = require( '@stdlib/utils/define-property' );
+var MatchSymbol = require( './../lib' );
+
+function ArrayLike() {
+	return {
+		'length': 3,
+		'0': 4,
+		'1': 5,
+		'2': 6
+	};
+}
+
+function Match( instance ) {
+	return isArray( instance );
+}
+
+var x = [ 1, 2, 3 ];
+
+defineProperty( ArrayLike, MatchSymbol, {
+	'configurable': true,
+	'value': null
+});
+console.log( instanceOf( x, ArrayLike ) );
+
+defineProperty( ArrayLike, MatchSymbol, {
+	'configurable': true,
+	'value': Match
+});
+console.log( instanceOf( x, ArrayLike ) );

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

@@ -0,0 +1,49 @@
+/**
+* @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 used to determine if a constructor object recognizes an object as its instance.
+*
+* @module @stdlib/symbol/match
+*
+* @example
+* var isArray = require( '@stdlib/assert/is-array' );
+* var MatchSymbol = require( '@stdlib/symbol/match' );
+*
+* function ArrayLike() {
+*     return {
+*         'length': 3,
+*         '0': 1,
+*         '1': 2,
+*         '2': 3
+*     };
+* };
+*
+* ArrayLike[ MatchSymbol ] = isArray;
+*/
+
+// MAIN //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;

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

@@ -0,0 +1,54 @@
+/**
+* @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 matchSymbolSupport = require( '@stdlib/assert/has-has-instance-symbol-support' );
+
+
+// MAIN //
+
+/**
+* Match symbol.
+*
+* @name MatchSymbol
+* @constant
+* @type {(symbol|null)}
+*
+* @example
+* var isArray = require( '@stdlib/assert/is-array' );
+*
+* function ArrayLike() {
+*     return {
+*         'length': 3,
+*         '0': 1,
+*         '1': 2,
+*         '2': 3
+*     };
+* };
+*
+* ArrayLike[ MatchSymbol ] = isArray;
+*/
+var MatchSymbol = ( matchSymbolSupport() ) ? Symbol.match : null;
+
+
+// EXPORTS //
+
+module.exports = MatchSymbol;