add-symbol/match

Author: aryan7071

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

@@ -20,7 +20,7 @@ limitations under the License.
 
 # MatchSymbol
 
-> [Symbol][mdn-symbol] which provides a method that matches the regular expression against a string.
+> [Symbol][mdn-symbol] which provides a method that matches a regular expression against a string.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -60,7 +60,6 @@ var s = typeof MatchSymbol;
 ## Notes
 
 -   The [symbol][mdn-symbol] is only supported in environments which support [symbols][mdn-symbol]. In non-supporting environments, the value is `null`.
--   When calling `String.prototype.match` and `String.prototype.matchAll` and the `pattern` argument is an object with a `[MatchSymbol]()` method, this method is called with the target string and replacement as arguments.
 
 </section>
 
@@ -76,27 +75,21 @@ var s = typeof MatchSymbol;
 
 ```javascript
 var defineProperty = require( '@stdlib/utils/define-property' );
-var ReplaceSymbol = require( '@stdlib/symbol/replace' );
-
-function replace( str, replacement ) {
-    return replacement;
-}
+var MatchSymbol = require( '@stdlib/symbol/match' );
 
-var obj = {};
+var regexp = /foo/;
 
-defineProperty( obj, ReplaceSymbol, {
+defineProperty( regexp, MatchSymbol, {
     'configurable': true,
-    'value': null
+    'enumerable': false,
+    'writable': true,
+    'value': false
 });
 
-var str = 'beep';
-console.log( str.replace( obj, 'boop' ) );
+console.log( "/foo/".startsWith( regexp ) );
+
+console.log( "/baz/".endsWith( regexp ) );
 
-defineProperty( obj, ReplaceSymbol, {
-    'configurable': true,
-    'value': replace
-});
-console.log( str.replace( obj, 'boop' ) );
 ```
 
 </section>

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

@@ -2,7 +2,7 @@
 {{alias}}
     Match symbol.
 
-    This symbol provides a method that matches the regular expression against a string.
+    This symbol provides a method that matches a regular expression against a string.
 
     The symbol is only supported in ES6/ES2015+ environments. For non-supporting
     environments, the value is `null`.

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

@@ -19,24 +19,23 @@
 'use strict';
 
 var defineProperty = require( '@stdlib/utils/define-property' );
-var ReplaceSymbol = require( './../lib' );
+var MatchSymbol = require( '@stdlib/symbol/match' );
 
-function replace( str, replacement ) {
-	return replacement;
-}
+var regexp = /foo/;
 
-var obj = {};
-
-defineProperty( obj, ReplaceSymbol, {
-	'configurable': true,
-	'value': null
+// override the default `Symbol.match` behavior using stdlib's `MatchSymbol`
+defineProperty( regexp, MatchSymbol, {
+    'configurable': true,
+    'enumerable': false,
+    'writable': true,
+    'value': false
 });
 
-var str = 'beep';
-console.log( str.replace( obj, 'boop' ) );
+// Without overriding MatchSymbol, this would normally throw an error in all engines:
+// "/foo/".startsWith(regexp);
+
+console.log( "/foo/".startsWith( regexp ) );
+// Expected output: true
+
+console.log( "/baz/".endsWith( regexp ) );
 
-defineProperty( obj, ReplaceSymbol, {
-	'configurable': true,
-	'value': replace
-});
-console.log( str.replace( obj, 'boop' ) );

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

@@ -19,19 +19,27 @@
 'use strict';
 
 /**
-* Symbol which provides a method for replacing substrings matched by the current object.
+* Symbol which provides a method that matches the regular expression against a string.
 *
 * @module @stdlib/symbol/match
 *
 * @example
-* var ReplaceSymbol = require( '@stdlib/symbol/replace' );
+* var defineProperty = require( '@stdlib/utils/define-property' );
+*var MatchSymbol = require( '@stdlib/symbol/match' );
 *
-* function replace( str, replacement ) {
-*     return replacement;
-* }
+*var regexp = /foo/;
 *
-* var obj = {};
-* obj[ ReplaceSymbol ] = replace;
+*
+*defineProperty( regexp, MatchSymbol, {
+*    'configurable': true,
+*    'enumerable': false,
+*    'writable': true,
+*    'value': false
+*});
+*
+*console.log( "/foo/".startsWith( regexp ) );
+*
+*console.log( "/baz/".endsWith( regexp ) );
 */
 
 // MAIN //

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

@@ -33,12 +33,21 @@ var hasMatchSymbolSupport = require( '@stdlib/assert/has-match-symbol-support' )
 * @type {(symbol|null)}
 *
 * @example
-* function replace( str, replacement ) {
-*     return replacement;
-* }
+* var defineProperty = require( '@stdlib/utils/define-property' );
+*var MatchSymbol = require( '@stdlib/symbol/match' );
 *
-* var obj = {};
-* obj[ ReplaceSymbol ] = replace;
+*var regexp = /foo/;
+*
+*defineProperty( regexp, MatchSymbol, {
+*    'configurable': true,
+*    'enumerable': false,
+*    'writable': true,
+*    'value': false
+*});
+*
+*console.log( "/foo/".startsWith( regexp ) );
+*
+*console.log( "/baz/".endsWith( regexp ) );
 */
 var MatchSymbol = ( hasMatchSymbolSupport() ) ? Symbol.match : null;