# bitcoincash-regex

> Regular expression for matching Bitcoin Cash (BCH) Legacy and CashAddr addresses.

Latest version **1.1.9** (published 2020-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install bitcoincash-regex
pnpm add bitcoincash-regex
yarn add bitcoincash-regex
bun add bitcoincash-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.9 |
| Published | 2020-08-08 |
| First published | 2018-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Nikolaos Kamarinakis |
| Maintainers | k4m4 |
| Keywords | bitcoincash, cashaddr, address, regex |

## Links

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

## Recent versions

- 1.1.9 (latest) — 2020-08-08
- 1.1.8 — 2020-04-04
- 1.1.7 — 2019-12-29
- 1.1.6 — 2019-12-29
- 1.1.5 — 2019-12-29
- 1.1.4 — 2019-12-22
- 1.1.3 — 2019-07-13
- 1.1.2 — 2019-07-13
- 1.1.1 — 2019-06-27
- 1.1.0 — 2019-06-27
- 1.0.6 — 2019-06-05
- 1.0.5 — 2019-02-10
- 1.0.4 — 2018-10-12
- 1.0.3 — 2018-02-24
- 1.0.2 — 2018-02-24
- … 2 more at https://npm.io/package/bitcoincash-regex/versions

## README

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

> Regular expression for matching Bitcoin Cash (BCH) Legacy and CashAddr addresses.


## Install

```
~ ❯❯❯ npm install bitcoincash-regex
```


## Usage

```js
const bchRegex = require('bitcoincash-regex')

bchRegex().test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
//=> true

bchRegex({exact: true}).test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k foo')
//=> false

bchRegex({exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
//=> true

bchRegex.format('cashaddr', {exact: true}).test('bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a')
//=> true

bchRegex.format('cashaddr', {exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
//=> false

'nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k unicorn bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a rainbow'.match(bchRegex());
//=> ['19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k', 'bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a']
```


## API

### bchRegex([options])

Returns a regex for matching BCH addresses.

#### options.exact

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

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


### bchRegex.format([format], [options])

Returns a regex for matching specific BCH format addresses.

#### format

Type: `string`<br>
Supported Formats: `legacy`, `cashaddr`

Match a specific BCH address format.

#### options.exact

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

Only match an exact string. Useful with `RegExp#test()` to check if a string is an BCH 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.
- [dash-regex](https://github.com/k4m4/dash-regex) - Regular expression for matching Dash addresses.
- [ripple-regex](https://github.com/k4m4/ripple-regex) - Regular expression for matching Ripple (XRP) addresses.
- [neo-regex](https://github.com/k4m4/neo-regex) - Regular expression for matching NEO 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/bitcoincash-regex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._