Rename import variable for clarity

Author: k4m4

index.js

@@ -9,13 +9,13 @@ const buildRegExp = (body, opts) => {
 	return opts.exact ? new RegExp('(?:^' + body + '$)') : new RegExp(body, 'g')
 }
 
-const bch = opts => {
+const bchRegex = opts => {
 	opts = opts || {}
 	const body = Object.keys(bchRegExps).map(format => '(?:' + bchRegExps[format] + ')').join('|')
 	return buildRegExp(body, opts)
 }
 
-bch.format = (format, opts) => {
+bchRegex.format = (format, opts) => {
 	opts = opts || {}
 	if (!bchRegExps[format]) {
 		throw new Error('Invalid BCH format')
@@ -25,4 +25,4 @@ bch.format = (format, opts) => {
 	return buildRegExp(body, opts)
 }
 
-module.exports = bch
+module.exports = bchRegex

index.test-d.ts

@@ -1,7 +1,7 @@
 import {expectType} from 'tsd';
-import bch = require('.');
+import bchRegex = require('.');
 
-expectType<RegExp>(bch());
-expectType<RegExp>(bch({exact: true}));
-expectType<RegExp>(bch.format('legacy'));
-expectType<RegExp>(bch.format('cashaddr', {exact: false}));
+expectType<RegExp>(bchRegex());
+expectType<RegExp>(bchRegex({exact: true}));
+expectType<RegExp>(bchRegex.format('legacy'));
+expectType<RegExp>(bchRegex.format('cashaddr', {exact: false}));

readme.md

@@ -13,21 +13,21 @@
 ## Usage
 
 ```js
-const bch = require('bitcoincash-regex')
+const bchRegex = require('bitcoincash-regex')
 
-bch().test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
+bchRegex().test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
 //=> true
 
-bch({exact: true}).test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k foo')
+bchRegex({exact: true}).test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k foo')
 //=> false
 
-bch({exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
+bchRegex({exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
 //=> true
 
-bch.format('cashaddr', {exact: true}).test('bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a')
+bchRegex.format('cashaddr', {exact: true}).test('bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a')
 //=> true
 
-bch.format('cashaddr', {exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
+bchRegex.format('cashaddr', {exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
 //=> false
 
 'nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k unicorn bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a rainbow'.match(bitcoincashRegex());
@@ -37,7 +37,7 @@ bch.format('cashaddr', {exact: true}).test('19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
 
 ## API
 
-### bch([options])
+### bchRegex([options])
 
 Returns a regex for matching BCH addresses.
 
@@ -49,7 +49,7 @@ 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.
 
 
-### bch.format([format], [options])
+### bchRegex.format([format], [options])
 
 Returns a regex for matching specific BCH format addresses.