bitcoincash-regex/index.d.ts

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

declare namespace bchRegex {
	interface Options {
		/**
		Only match an exact string. By default, it matches any BCH addresses in a string. Useful with `RegExp#test()` to check if a string is an BCH address.
		@default false
		*/
		readonly exact?: boolean;
	}
	/**
	Available BCH formats.
	*/
	type Format = 'legacy' | 'cashaddr'
}

declare const bchRegex: {
	/**
	Returns a regex for matching specific BCH format addresses.
	@example
	```
	import bchRegex = require('bitcoincash-regex')
	bchRegex.format('cashaddr', {exact: true}).test('bitcoincash:qpm2qsznhks23z7629mms6s4cwef74vcwvy22gdx6a')
	//=> true
	```
	*/
	format: (format: bchRegex.Format, options?: bchRegex.Options) => RegExp;

	/**
	Returns a regex for matching BCH addresses.
	@example
	```
	import bchRegex = require('bitcoincash-regex')
	bchRegex().test('nodejsrocks 19hZx234vNtLazfx5J2bxHsiWEmeYE8a7k')
	//=> true
	```
	*/
	(options?: bchRegex.Options): RegExp;
}

export = bchRegex