From b5a1608a96cd9720b4a1f8ea4e4b683021ff529c Mon Sep 17 00:00:00 2001 From: Nolan Lawson Date: Mon, 21 May 2018 14:10:24 -0700 Subject: [PATCH] prevent typedoc generating docs for private functions --- README.md | 31 ------------------------------- package.json | 2 +- src/blob-util.ts | 34 +--------------------------------- src/private.ts | 36 ++++++++++++++++++++++++++++++++++++ 4 files changed, 38 insertions(+), 65 deletions(-) create mode 100644 src/private.ts diff --git a/README.md b/README.md index 8a3323f..7208db1 100644 --- a/README.md +++ b/README.md @@ -565,37 +565,6 @@ blobUtil.imgSrcToDataURL('http://some-other-site.com/img.jpg', 'image/jpeg', **Returns:** `Promise`<`string`> Promise that resolves with the data URL string -___ - - -### `` imgToCanvas - -▸ **imgToCanvas**(img: *`any`*): `HTMLCanvasElement` - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| img | `any` | - -**Returns:** `HTMLCanvasElement` - -___ - - -### `` loadImage - -▸ **loadImage**(src: *`any`*, crossOrigin: *`any`*): `Promise`<`Object`> - -**Parameters:** - -| Param | Type | -| ------ | ------ | -| src | `any` | -| crossOrigin | `any` | - -**Returns:** `Promise`<`Object`> - ___ diff --git a/package.json b/package.json index fcb8c42..5608909 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "build-umd": "rollup -i lib/blob-util.js -f umd -n blobUtil -o dist/blob-util.js", "min": "uglifyjs dist/blob-util.js -mc > dist/blob-util.min.js", "doc": "run-s cleanup-doc gen-doc gen-readme cleanup-doc", - "gen-doc": "typedoc --out docs-tmp --target ES6 --theme markdown --mdHideSources --excludePrivate src", + "gen-doc": "typedoc --out docs-tmp --target ES6 --theme markdown --mdHideSources --excludePrivate --exclude private.ts src", "gen-readme": "node bin/write-docs-to-readme.js", "cleanup-doc": "rimraf docs-tmp" }, diff --git a/src/blob-util.ts b/src/blob-util.ts index 9ba861a..4035a14 100644 --- a/src/blob-util.ts +++ b/src/blob-util.ts @@ -14,39 +14,7 @@ declare var WebKitBlobBuilder: any /** @private */ declare var webkitURL: any -/** @private */ -function loadImage (src, crossOrigin) { - return new Promise(function (resolve, reject) { - var img = new Image() - if (crossOrigin) { - img.crossOrigin = crossOrigin - } - img.onload = function () { - resolve(img) - } - img.onerror = reject - img.src = src - }) -} - -/** @private */ -function imgToCanvas (img) { - var canvas = document.createElement('canvas') - - canvas.width = img.width - canvas.height = img.height - - // copy the image contents to the canvas - var context = canvas.getContext('2d') - context.drawImage( - img, - 0, 0, - img.width, img.height, - 0, 0, - img.width, img.height) - - return canvas -} +import { loadImage, imgToCanvas } from './private' /** * Shim for diff --git a/src/private.ts b/src/private.ts new file mode 100644 index 0000000..8b9bb7b --- /dev/null +++ b/src/private.ts @@ -0,0 +1,36 @@ +// TODO: including these in blob-util.ts causes typedoc to generate docs for them, +// even with --excludePrivate ¯\_(ツ)_/¯ + +/** @private */ +export function loadImage (src, crossOrigin) { + return new Promise(function (resolve, reject) { + var img = new Image() + if (crossOrigin) { + img.crossOrigin = crossOrigin + } + img.onload = function () { + resolve(img) + } + img.onerror = reject + img.src = src + }) +} + +/** @private */ +export function imgToCanvas (img) { + var canvas = document.createElement('canvas') + + canvas.width = img.width + canvas.height = img.height + + // copy the image contents to the canvas + var context = canvas.getContext('2d') + context.drawImage( + img, + 0, 0, + img.width, img.height, + 0, 0, + img.width, img.height) + + return canvas +}