Add types to functions exported as API in src/pdf.js.

This commit is contained in:
Takashi Tamura 2020-08-03 19:19:48 +09:00
parent 00a8b42e67
commit bc4648c0a6
2 changed files with 11 additions and 1 deletions

View File

@ -446,7 +446,10 @@ function addLinkAttributes(link, { url, target, rel, enabled = true } = {}) {
link.rel = typeof rel === "string" ? rel : DEFAULT_LINK_REL;
}
// Gets the file name from a given URL.
/**
* Gets the file name from a given URL.
* @param {string} url
*/
function getFilenameFromUrl(url) {
const anchor = url.indexOf("#");
const query = url.indexOf("?");
@ -520,6 +523,10 @@ function isValidFetchUrl(url, baseUrl) {
}
}
/**
* @param {string} src
* @returns {Promise<void>}
*/
function loadScript(src) {
return new Promise((resolve, reject) => {
const script = document.createElement("script");

View File

@ -467,6 +467,9 @@ class AbortException extends BaseException {}
const NullCharactersRegExp = /\x00/g;
/**
* @param {string} str
*/
function removeNullCharacters(str) {
if (typeof str !== "string") {
warn("The argument for removeNullCharacters must be a string.");