bitcoincash-regex
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.9 • Public • Published

    bitcoincash-regex Build Status XO code style

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

    Install

    ~ ❯❯❯ npm install bitcoincash-regex
    

    Usage

    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
    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
    Supported Formats: legacy, cashaddr

    Match a specific BCH address format.

    options.exact

    Type: boolean
    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 - Regular expression for matching Ethereum (ETH) addresses.
    • litecoin-regex - Regular expression for matching Litecoin (LTC) addresses.
    • monero-regex - Regular expression for matching Monero (XMR) addresses.
    • dash-regex - Regular expression for matching Dash addresses.
    • ripple-regex - Regular expression for matching Ripple (XRP) addresses.
    • neo-regex - Regular expression for matching NEO addresses.
    • dogecoin-regex - Regular expression for matching Dogecoin (DOGE) addresses.

    License

    MIT © Nikolaos Kamarinakis

    Install

    npm i bitcoincash-regex

    DownloadsWeekly Downloads

    300

    Version

    1.1.9

    License

    MIT

    Unpacked Size

    6.27 kB

    Total Files

    5

    Last publish

    Collaborators

    • k4m4