# Regular Expressions

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]

> Standard library regular expressions.

## Installation

```bash
npm install @stdlib/regexp
```


## Usage

```javascript
var regexp = require( '@stdlib/regexp' );
```

#### regexp

Standard library regular expressions.

```javascript
var re = regexp;
// returns {...}
```

The following regular expressions are currently exported:

-   [`reBasenamePosix()`][@stdlib/regexp/basename-posix]: regular expression to capture the last part of a POSIX path.
-   [`reBasenameWindows()`][@stdlib/regexp/basename-windows]: regular expression to capture the last part of a Windows path.
-   [`reBasename( [platform] )`][@stdlib/regexp/basename]: regular expression to capture the last part of a path.
-   [`reColorHexadecimal( [mode] )`][@stdlib/regexp/color-hexadecimal]: regular expression to match a hexadecimal color.
-   [`reDecimalNumber( [options] )`][@stdlib/regexp/decimal-number]: regular expression to match a decimal number.
-   [`reDirnamePosix()`][@stdlib/regexp/dirname-posix]: regular expression to capture a POSIX path dirname.
-   [`reDirnameWindows()`][@stdlib/regexp/dirname-windows]: regular expression to capture a Windows path dirname.
-   [`reDirname( [platform] )`][@stdlib/regexp/dirname]: regular expression to capture a path dirname.
-   [`reEOL( [options] )`][@stdlib/regexp/eol]: regular expression to match a newline character sequence.
-   [`reExtendedLengthPath()`][@stdlib/regexp/extended-length-path]: regular expression to detect an extended-length path.
-   [`reExtnamePosix()`][@stdlib/regexp/extname-posix]: regular expression to capture a POSIX filename extension.
-   [`reExtnameWindows()`][@stdlib/regexp/extname-windows]: regular expression to capture a Windows filename extension.
-   [`reExtname( [platform] )`][@stdlib/regexp/extname]: regular expression to capture a filename extension.
-   [`reFilenamePosix()`][@stdlib/regexp/filename-posix]: regular expression to split a POSIX filename.
-   [`reFilenameWindows()`][@stdlib/regexp/filename-windows]: regular expression to split a Windows filename.
-   [`reFilename( [platform] )`][@stdlib/regexp/filename]: regular expression to split a filename.
-   [`reFunctionName`][@stdlib/regexp/function-name]: regular expression to capture a function name.
-   [`reNativeFunction()`][@stdlib/regexp/native-function]: regular expression to match a native function.
-   [`reRegExp()`][@stdlib/regexp/regexp]: regular expression to parse a regular expression string.
-   [`reUncPath()`][@stdlib/regexp/unc-path]: regular expression to parse a UNC path.
-   [`reUtf16SurrogatePair()`][@stdlib/regexp/utf16-surrogate-pair]: regular expression to match a UTF-16 surrogate pair.
-   [`reUtf16UnpairedSurrogate()`][@stdlib/regexp/utf16-unpaired-surrogate]: regular expression to match an unpaired UTF-16 surrogate.
-   [`reWhitespace( [options] )`][@stdlib/regexp/whitespace]: regular expression to match a white space character.

## Examples

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var regexp = require( '@stdlib/regexp' );

console.log( objectKeys( regexp ) );
```


* * *

## Notice

This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/regexp.svg
[npm-url]: https://npmjs.org/package/@stdlib/regexp

[test-image]: https://github.com/stdlib-js/regexp/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/regexp/actions/workflows/test.yml

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/regexp/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/regexp?branch=main

[dependencies-image]: https://img.shields.io/david/stdlib-js/regexp.svg
[dependencies-url]: https://david-dm.org/stdlib-js/regexp/main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/regexp/main/LICENSE

[@stdlib/regexp/basename-posix]: https://github.com/stdlib-js/regexp/tree/main/basename-posix

[@stdlib/regexp/basename-windows]: https://github.com/stdlib-js/regexp/tree/main/basename-windows

[@stdlib/regexp/basename]: https://github.com/stdlib-js/regexp/tree/main/basename

[@stdlib/regexp/color-hexadecimal]: https://github.com/stdlib-js/regexp/tree/main/color-hexadecimal

[@stdlib/regexp/decimal-number]: https://github.com/stdlib-js/regexp/tree/main/decimal-number

[@stdlib/regexp/dirname-posix]: https://github.com/stdlib-js/regexp/tree/main/dirname-posix

[@stdlib/regexp/dirname-windows]: https://github.com/stdlib-js/regexp/tree/main/dirname-windows

[@stdlib/regexp/dirname]: https://github.com/stdlib-js/regexp/tree/main/dirname

[@stdlib/regexp/eol]: https://github.com/stdlib-js/regexp/tree/main/eol

[@stdlib/regexp/extended-length-path]: https://github.com/stdlib-js/regexp/tree/main/extended-length-path

[@stdlib/regexp/extname-posix]: https://github.com/stdlib-js/regexp/tree/main/extname-posix

[@stdlib/regexp/extname-windows]: https://github.com/stdlib-js/regexp/tree/main/extname-windows

[@stdlib/regexp/extname]: https://github.com/stdlib-js/regexp/tree/main/extname

[@stdlib/regexp/filename-posix]: https://github.com/stdlib-js/regexp/tree/main/filename-posix

[@stdlib/regexp/filename-windows]: https://github.com/stdlib-js/regexp/tree/main/filename-windows

[@stdlib/regexp/filename]: https://github.com/stdlib-js/regexp/tree/main/filename

[@stdlib/regexp/function-name]: https://github.com/stdlib-js/regexp/tree/main/function-name

[@stdlib/regexp/native-function]: https://github.com/stdlib-js/regexp/tree/main/native-function

[@stdlib/regexp/regexp]: https://github.com/stdlib-js/regexp/tree/main/regexp

[@stdlib/regexp/unc-path]: https://github.com/stdlib-js/regexp/tree/main/unc-path

[@stdlib/regexp/utf16-surrogate-pair]: https://github.com/stdlib-js/regexp/tree/main/utf16-surrogate-pair

[@stdlib/regexp/utf16-unpaired-surrogate]: https://github.com/stdlib-js/regexp/tree/main/utf16-unpaired-surrogate

[@stdlib/regexp/whitespace]: https://github.com/stdlib-js/regexp/tree/main/whitespace

