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

84 lines
1.9 KiB
Plaintext

{{alias}}( [platform] )
Regular expression to split a filename.
The regular expression is platform-dependent. If the current process is
running on Windows, the regular expression is `*.REGEXP_WIN32`; otherwise,
`*.REGEXP_POSIX`.
Parameters
----------
platform: string (optional)
Path platform (either `posix` or `win32`).
Returns
-------
re: RegExp
Regular expression.
Examples
--------
> var RE = {{alias}}()
<RegExp>
> var RE_POSIX = {{alias}}( 'posix' );
> var parts = RE_POSIX.exec( '/foo/bar/index.js' ).slice()
<Array>
> var RE_WIN32 = {{alias}}( 'win32' );
> parts = RE.exec( 'C:\\foo\\bar\\index.js' ).slice()
<Array>
> var str = RE.toString();
> var bool = ( str === RE_POSIX.toString() || str === RE_WIN32.toString() )
true
{{alias}}.REGEXP
Regular expression to split a filename.
Examples
--------
> var RE = {{alias}}.REGEXP
<RegExp>
{{alias}}.REGEXP_POSIX
Regular expression to split a POSIX filename.
When executed, the regular expression splits a POSIX filename into the
following parts:
- input value
- root
- dirname
- basename
- extname
Examples
--------
> var f = '/foo/bar/index.js';
> var parts = {{alias}}.REGEXP_POSIX.exec( f ).slice()
[ '/foo/bar/index.js', '/', 'foo/bar/', 'index.js', '.js' ]
{{alias}}.REGEXP_WIN32
Regular expression to split a Windows filename.
When executed, the regular expression splits a Windows filename into the
following parts:
- input value
- device
- slash
- dirname
- basename
- extname
Examples
--------
> var f = 'C:\\foo\\bar\\index.js';
> var parts = {{alias}}.REGEXP_WIN32.exec( f ).slice()
[ 'C:\\foo\\bar\\index.js', 'C:', '\\', 'foo\\bar\\', 'index.js', '.js' ]
See Also
--------