1
0
mirror of synced 2025-11-08 12:57:47 +00:00

docs(typedoc): hide browser createHash function from TypeDoc, add description

This commit is contained in:
Jason Dreyzehner
2017-02-28 23:25:06 -05:00
parent b3084d12e5
commit 1111ba297e
2 changed files with 6 additions and 1 deletions

View File

@@ -27,7 +27,7 @@
"cov": "yarn unit && yarn html-coverage && opn coverage/index.html",
"html-coverage": "nyc report --reporter=html",
"send-coverage": "nyc report --reporter=lcov > coverage.lcov && codecov",
"docs": "typedoc src/index.ts --excludePrivate --exclude src/adapters/*.ts --mode file --theme minimal --out build/docs && opn build/docs/index.html",
"docs": "typedoc src/index.ts --excludePrivate --mode file --theme minimal --out build/docs && opn build/docs/index.html",
"docs:json": "typedoc --mode file --json build/docs/typedoc.json src/index.ts",
"release": "standard-version"
},

View File

@@ -2,6 +2,11 @@
// https://github.com/rollup/rollup-plugin-commonjs/issues/105#issuecomment-281917166
import hash from 'hash.js'
/**
* Simulate the Node.js crypto.createHash function using hash.js' implementation.
* @internal
* @hidden (TypeDoc currently doesn't understand @internal)
*/
export function createHash (algorithm: 'sha256') {
return hash.sha256()
}