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

mozilla · Aug 3, 2020 · bc4648c · bc4648c
1 parent 00a8b42
commit bc4648c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/src/display/display_utils.js b/src/display/display_utils.js
@@ -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");

diff --git a/src/shared/util.js b/src/shared/util.js
@@ -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.");