Exclude the setPDFNetworkStreamFactory
function from the built API docs
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:
parent
c3c197d87a
commit
5eabe08c74
@ -63,20 +63,25 @@ const RENDERING_CANCELLED_TIMEOUT = 100; // ms
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @typedef {function} IPDFStreamFactory
|
* @typedef {function} IPDFStreamFactory
|
||||||
* @param {DocumentInitParameters} params The document initialization
|
* @param {DocumentInitParameters} params - The document initialization
|
||||||
* parameters. The "url" key is always present.
|
* parameters. The "url" key is always present.
|
||||||
* @returns {IPDFStream}
|
* @returns {IPDFStream}
|
||||||
|
* @ignore
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/** @type IPDFStreamFactory */
|
/**
|
||||||
|
* @type IPDFStreamFactory
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
let createPDFNetworkStream;
|
let createPDFNetworkStream;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the function that instantiates a IPDFStream as an alternative PDF data
|
* Sets the function that instantiates an {IPDFStream} as an alternative PDF
|
||||||
* transport.
|
* data transport.
|
||||||
* @param {IPDFStreamFactory} pdfNetworkStreamFactory - the factory function
|
* @param {IPDFStreamFactory} pdfNetworkStreamFactory - The factory function
|
||||||
* that takes document initialization parameters (including a "url") and returns
|
* that takes document initialization parameters (including a "url") and
|
||||||
* an instance of IPDFStream.
|
* returns an instance of {IPDFStream}.
|
||||||
|
* @ignore
|
||||||
*/
|
*/
|
||||||
function setPDFNetworkStreamFactory(pdfNetworkStreamFactory) {
|
function setPDFNetworkStreamFactory(pdfNetworkStreamFactory) {
|
||||||
createPDFNetworkStream = pdfNetworkStreamFactory;
|
createPDFNetworkStream = pdfNetworkStreamFactory;
|
||||||
|
Loading…
x
Reference in New Issue
Block a user