Merge branch 'runcase'

package.json

@@ -89,6 +89,7 @@
     "tiny-secp256k1": "^2.2.0",
     "ts-node": "^8.3.0",
     "typedoc": "^0.25.1",
+    "typedoc-plugin-bitcoinjs-runcase": "^1.0.2",
     "typescript": "^4.4.4"
   },
   "license": "MIT"

src/address.d.ts

@@ -9,7 +9,9 @@
  * @packageDocumentation
  */
 import { Network } from './networks';
-/** base58check decode result */
+/**
+ * base58check decode result
+ */
 export interface Base58CheckResult {
     /** address hash */
     hash: Buffer;
@@ -27,10 +29,32 @@ export interface Bech32Result {
 }
 /**
  * decode address with base58 specification,  return address version and address hash if valid
+ * * @case
+ * ```ts
+ * // You can test it here and find more case in test/address.spec.ts
+ *
+ * const decode = address.fromBase58Check('1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH')
+ *
+ * console.log(decode.version) // 0
+ *
+ * console.log(decode.hash.toString('hex')) // 751e76e8199196d454941c45d1b3a323f1433bd6
+ * ```
  */
 export declare function fromBase58Check(address: string): Base58CheckResult;
 /**
  * decode address with bech32 specification,  return address version、address prefix and address data if valid
+ * * @case
+ * ```ts
+ * // You can test it here and find more case in test/address.spec.ts
+ *
+ * const actual = address.fromBech32('tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy')
+ *
+ * console.log(actual.version) // 0
+ *
+ * console.log(actual.prefix) // tb
+ *
+ * console.log(actual.data.toString('hex')) // 000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433
+ * ```
  */
 export declare function fromBech32(address: string): Bech32Result;
 /**

src/address.js

@@ -43,6 +43,16 @@ function _toFutureSegwitAddress(output, network) {
 }
 /**
  * decode address with base58 specification,  return address version and address hash if valid
+ * * @case
+ * ```ts
+ * // You can test it here and find more case in test/address.spec.ts
+ *
+ * const decode = address.fromBase58Check('1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH')
+ *
+ * console.log(decode.version) // 0
+ *
+ * console.log(decode.hash.toString('hex')) // 751e76e8199196d454941c45d1b3a323f1433bd6
+ * ```
  */
 function fromBase58Check(address) {
   const payload = Buffer.from(bs58check.decode(address));
@@ -56,6 +66,18 @@ function fromBase58Check(address) {
 exports.fromBase58Check = fromBase58Check;
 /**
  * decode address with bech32 specification,  return address version、address prefix and address data if valid
+ * * @case
+ * ```ts
+ * // You can test it here and find more case in test/address.spec.ts
+ *
+ * const actual = address.fromBech32('tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy')
+ *
+ * console.log(actual.version) // 0
+ *
+ * console.log(actual.prefix) // tb
+ *
+ * console.log(actual.data.toString('hex')) // 000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433
+ * ```
  */
 function fromBech32(address) {
   let result;

ts_src/address.ts

@@ -15,7 +15,9 @@ import { typeforce, tuple, Hash160bit, UInt8 } from './types';
 import { bech32, bech32m } from 'bech32';
 import * as bs58check from 'bs58check';
 
-/** base58check decode result */
+/**
+ * base58check decode result
+ */
 export interface Base58CheckResult {
   /** address hash */
   hash: Buffer;
@@ -71,6 +73,16 @@ function _toFutureSegwitAddress(output: Buffer, network: Network): string {
 
 /**
  * decode address with base58 specification,  return address version and address hash if valid
+ * * @case
+ * ```ts
+ * // You can test it here and find more case in test/address.spec.ts 
+ * 
+ * const decode = address.fromBase58Check('1BgGZ9tcN4rm9KBzDn7KprQz87SZ26SAMH')
+ * 
+ * console.log(decode.version) // 0
+ * 
+ * console.log(decode.hash.toString('hex')) // 751e76e8199196d454941c45d1b3a323f1433bd6
+ * ```
  */
 export function fromBase58Check(address: string): Base58CheckResult {
   const payload = Buffer.from(bs58check.decode(address));
@@ -87,6 +99,18 @@ export function fromBase58Check(address: string): Base58CheckResult {
 
 /**
  * decode address with bech32 specification,  return address version、address prefix and address data if valid
+ * * @case
+ * ```ts
+ * // You can test it here and find more case in test/address.spec.ts 
+ * 
+ * const actual = address.fromBech32('tb1qqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesrxh6hy')
+ * 
+ * console.log(actual.version) // 0
+ * 
+ * console.log(actual.prefix) // tb
+ * 
+ * console.log(actual.data.toString('hex')) // 000000c4a5cad46221b2a187905e5266362b99d5e91c6ce24d165dab93e86433
+ * ```
  */
 export function fromBech32(address: string): Bech32Result {
   let result;

typedoc.json

@@ -10,6 +10,7 @@
   "searchGroupBoosts": {
     "Classes": 1.5
   },
+  "plugin": ["typedoc-plugin-bitcoinjs-runcase"],
   "visibilityFilters": {},
   "hideGenerator": true,
   "excludePrivate": true,