Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Exclude the setPDFNetworkStreamFactory function from the built API docs

Browse Source 
Please note that the `setPDFNetworkStreamFactory` functionality isn't exposed in the public API, i.e. not listed among the exports in the `src/pdf.js` file, and that even if it were it wouldn't really be useful considering that none of the `PDFNetworkStream`/`PDFFetchStream`/`PDFNodeStream` classes are exported either.
This commit is contained in:
Jonas Jenwald 2020-03-23 16:34:25 +01:00
parent c3c197d87a
commit 5eabe08c74
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/display/api.js
View File

@ -63,20 +63,25 @@ const RENDERING_CANCELLED_TIMEOUT = 100; // ms
/**
* @typedef {function} IPDFStreamFactory
* @param {DocumentInitParameters} params The document initialization
* parameters. The "url" key is always present.
* @param {DocumentInitParameters} params - The document initialization
* parameters. The "url" key is always present.
* @returns {IPDFStream}
* @ignore
*/
/** @type IPDFStreamFactory */
/**
* @type IPDFStreamFactory
* @private
*/
let createPDFNetworkStream;
/**
* Sets the function that instantiates a IPDFStream as an alternative PDF data
* transport.
* @param {IPDFStreamFactory} pdfNetworkStreamFactory - the factory function
* that takes document initialization parameters (including a "url") and returns
* an instance of IPDFStream.
* Sets the function that instantiates an {IPDFStream} as an alternative PDF
* data transport.
* @param {IPDFStreamFactory} pdfNetworkStreamFactory - The factory function
* that takes document initialization parameters (including a "url") and
* returns an instance of {IPDFStream}.
* @ignore
*/
function setPDFNetworkStreamFactory(pdfNetworkStreamFactory) {
createPDFNetworkStream = pdfNetworkStreamFactory;