time-to-botec/squiggle/node_modules/@stdlib/regexp/eol/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

51 lines
1.0 KiB
Plaintext

{{alias}}( [options] )
Regular expression to match a newline character sequence: /\r?\n/.
Parameters
----------
options: Object (optional)
Options.
options.flags: string (optional)
Regular expression flags. Default: ''.
options.capture: boolean (optional)
Boolean indicating whether to create a capture group for the match.
Default: false.
Returns
-------
regexp: RegExp
Regular expression.
Examples
--------
> var RE_EOL = {{alias}}();
> var bool = RE_EOL.test( '\n' )
true
> bool = RE_EOL.test( '\r\n' )
true
> bool = RE_EOL.test( '\\r\\n' )
false
{{alias}}.REGEXP
Regular expression to match a newline character sequence: /\r?\n/.
Examples
--------
> var bool = {{alias}}.REGEXP.test( 'abc' )
false
{{alias}}.REGEXP_CAPTURE
Regular expression to capture a newline character sequence: /\r?\n/.
Examples
--------
> var parts = {{alias}}.REGEXP_CAPTURE.exec( '\n' )
[ '\n', '\n' ]
See Also
--------