Update typedoc

This commit is contained in:
Miguel Mota 2020-06-06 12:26:33 -07:00
parent a69a927e8e
commit 8768f93132
3 changed files with 611 additions and 437 deletions

1020
README.md

File diff suppressed because it is too large Load Diff

View File

@ -28,15 +28,15 @@ type TLayer = any
* @namespace MerkleTree * @namespace MerkleTree
*/ */
export class MerkleTree { export class MerkleTree {
duplicateOdd: boolean private duplicateOdd: boolean
hashAlgo: (value: TValue) => THashAlgo private hashAlgo: (value: TValue) => THashAlgo
hashLeaves: boolean private hashLeaves: boolean
isBitcoinTree: boolean private isBitcoinTree: boolean
leaves: TLeaf[] private leaves: TLeaf[]
layers: TLayer[] private layers: TLayer[]
sortLeaves: boolean private sortLeaves: boolean
sortPairs: boolean private sortPairs: boolean
sort: boolean private sort: boolean
/** /**
* @desc Constructs a Merkle Tree. * @desc Constructs a Merkle Tree.

View File

@ -11,7 +11,7 @@
"test": "tape test/*.js", "test": "tape test/*.js",
"build": "rm -rf dist/ && tsc", "build": "rm -rf dist/ && tsc",
"lint": "standardx --fix index.ts test/*.js", "lint": "standardx --fix index.ts test/*.js",
"docs": "rm -rf docs/ && typedoc --theme markdown index.ts --out docs --mdEngine github --mdDocusaurus --mdHideSources" "docs": "rm -rf docs/ && typedoc --plugin typedoc-plugin-markdown --theme markdown --hideGenerator --excludeExternals --excludePrivate --out docs index.ts"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -50,8 +50,8 @@
"standard": "^14.3.4", "standard": "^14.3.4",
"standardx": "^5.0.0", "standardx": "^5.0.0",
"tape": "^4.9.2", "tape": "^4.9.2",
"typedoc": "^0.14.2", "typedoc": "^0.17.7",
"typedoc-plugin-markdown": "^1.2.1", "typedoc-plugin-markdown": "^2.3.1",
"typescript": "^3.4.1" "typescript": "^3.4.1"
}, },
"engines": { "engines": {
@ -72,6 +72,8 @@
}, },
"standardx": { "standardx": {
"parser": "@typescript-eslint/parser", "parser": "@typescript-eslint/parser",
"plugins": [ "@typescript-eslint/eslint-plugin" ] "plugins": [
"@typescript-eslint/eslint-plugin"
]
} }
} }