time-to-botec/js/node_modules/@stdlib/regexp/whitespace/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

73 lines
1.8 KiB
Plaintext

{{alias}}( [options] )
Returns a regular expression to match a white space character.
Parameters
----------
options: Object (optional)
Options.
options.flags: string (optional)
Regular expression flags. Default: ''.
options.capture: boolean (optional)
Boolean indicating whether to wrap a regular expression matching a white
space character with a capture group. Default: false.
Returns
-------
re: RegExp
Regular expression.
Examples
--------
> var RE = {{alias}}();
> var bool = RE.test( '\n' )
true
> bool = RE.test( ' ' )
true
> bool = RE.test( 'a' )
false
{{alias}}.REGEXP
Regular expression to match a white space character.
Matches the 25 characters defined as white space ("WSpace=Y","WS")
characters in the Unicode 9.0 character database.
Matches one related white space character without the Unicode character
property "WSpace=Y" (zero width non-breaking space which was deprecated as
of Unicode 3.2).
Examples
--------
> var RE = {{alias}}.REGEXP;
> var bool = RE.test( '\n' )
true
> bool = RE.test( ' ' )
true
> bool = RE.test( 'a' )
false
{{alias}}.REGEXP_CAPTURE
Regular expression to capture white space characters.
Matches the 25 characters defined as white space ("WSpace=Y","WS")
characters in the Unicode 9.0 character database.
Matches one related white space character without the Unicode character
property "WSpace=Y" (zero width non-breaking space which was deprecated as
of Unicode 3.2).
Examples
--------
> var RE = {{alias}}.REGEXP_CAPTURE;
> var str = 'Duplicate capture';
> var out = {{alias:@stdlib/string/replace}}( str, RE, '$1$1' )
'Duplicate capture'
See Also
--------