From 1111ba297e65aa4062b704f56fe42c606257efe7 Mon Sep 17 00:00:00 2001 From: Jason Dreyzehner Date: Tue, 28 Feb 2017 23:25:06 -0500 Subject: [PATCH] docs(typedoc): hide browser createHash function from TypeDoc, add description --- package.json | 2 +- src/adapters/crypto.browser.ts | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 8dab8a1..caaccc6 100644 --- a/package.json +++ b/package.json @@ -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" }, diff --git a/src/adapters/crypto.browser.ts b/src/adapters/crypto.browser.ts index d500144..f8f7ac7 100644 --- a/src/adapters/crypto.browser.ts +++ b/src/adapters/crypto.browser.ts @@ -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() }