# ripple-regex

> Regular expression for matching Ripple (XRP) addresses.

Latest version **1.1.8** (published 2020-04-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install ripple-regex
pnpm add ripple-regex
yarn add ripple-regex
bun add ripple-regex
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.8 |
| Published | 2020-04-04 |
| First published | 2018-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=9 |
| Dependencies | 0 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Nikolaos Kamarinakis |
| Maintainers | k4m4 |
| Keywords | ripple, address, regex |

## Links

- npm: https://www.npmjs.com/package/ripple-regex
- Repository: https://github.com/k4m4/ripple-regex
- Homepage: https://github.com/k4m4/ripple-regex#readme
- Issues: https://github.com/k4m4/ripple-regex/issues
- npm.io page: https://npm.io/package/ripple-regex

## Recent versions

- 1.1.8 (latest) — 2020-04-04
- 1.1.7 — 2019-12-22
- 1.1.6 — 2019-07-13
- 1.1.5 — 2019-07-13
- 1.1.4 — 2019-02-10
- 1.1.3 — 2018-10-12
- 1.1.2 — 2018-02-24

## README

# ripple-regex [![Build Status](https://travis-ci.org/k4m4/ripple-regex.svg?branch=master)](https://travis-ci.org/k4m4/ripple-regex) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)

> Regular expression for matching Ripple (XRP) addresses


## Install

```
~ ❯❯❯ npm install ripple-regex
```


## Usage

```js
const rippleRegex = require('ripple-regex');

rippleRegex().test('nodejsrocks rG2ZJRab3EGBmpoxUyiF2guB3GoQTwMGEC');
//=> true

rippleRegex({exact: true}).test('nodejsrocks rG2ZJRab3EGBmpoxUyiF2guB3GoQTwMGEC foo');
//=> false

rippleRegex({exact: true}).test('rG2ZJRab3EGBmpoxUyiF2guB3GoQTwMGEC');
//=> true

'nodejsrocks rG2ZJRab3EGBmpoxUyiF2guB3GoQTwMGEC unicorn rfBKzgkPt9EvSJmk1uhoWTauaFCaRh4jMp rainbow'.match(rippleRegex());
//=> ['rG2ZJRab3EGBmpoxUyiF2guB3GoQTwMGEC', 'rfBKzgkPt9EvSJmk1uhoWTauaFCaRh4jMp']
```


## API

### rippleRegex([options])

Returns a regex for matching XRP addresses.

#### options.exact

Type: `boolean`<br>
Default: `false` *(Matches any XRP address in a string)*

Only match an exact string. Useful with `RegExp#test()` to check if a string is an XRP address.


## Related

- [ethereum-regex](https://github.com/k4m4/ethereum-regex) - Regular expression for matching Ethereum (ETH) addresses.
- [litecoin-regex](https://github.com/k4m4/litecoin-regex) - Regular expression for matching Litecoin (LTC) addresses.
- [monero-regex](https://github.com/k4m4/monero-regex) - Regular expression for matching Monero (XMR) addresses.
- [bitcoincash-regex](https://github.com/k4m4/bitcoincash-regex) - Regular expression for matching Bitcoin Cash (BCH) addresses.
- [neo-regex](https://github.com/k4m4/neo-regex) - Regular expression for matching NEO addresses.
- [dash-regex](https://github.com/k4m4/dash-regex) - Regular expression for matching Dash addresses.
- [dogecoin-regex](https://github.com/k4m4/dogecoin-regex) - Regular expression for matching Dogecoin (DOGE) addresses.


## License

MIT © [Nikolaos Kamarinakis](https://nikolaskama.me)

---
_Source: https://npm.io/package/ripple-regex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._