fix(types): change types of children & gallery options according to docs

dimsemenov · Oct 25, 2022 · 1530ea7 · 1530ea7
2 parents ab74267 + d3c3a9c
commit 1530ea7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/js/photoswipe.js b/src/js/photoswipe.js
@@ -51,6 +51,10 @@ import ContentLoader from './slide/loader.js';
 /** @typedef {Type<PhotoSwipe> | { default: Type<PhotoSwipe> }} PhotoSwipeModule */
 /** @typedef {PhotoSwipeModule | Promise<PhotoSwipeModule> | (() => Promise<PhotoSwipeModule>)} PhotoSwipeModuleOption */
 
+/**
+ * @typedef {string | NodeListOf<HTMLElement> | HTMLElement[] | HTMLElement} ElementProvider
+ */
+
 /**
  * @typedef {Object} PhotoSwipeOptions https://photoswipe.com/options/
  *
@@ -208,9 +212,9 @@ import ContentLoader from './slide/loader.js';
  * @prop {PhotoSwipeModuleOption} [pswpModule]
  * @prop {() => Promise<any>} [openPromise]
  * @prop {boolean=} preloadFirstSlide
- * @prop {string=} gallery
+ * @prop {ElementProvider=} gallery
  * @prop {string=} gallerySelector
- * @prop {string=} children
+ * @prop {ElementProvider=} children
  * @prop {string=} childSelector
  * @prop {string | false} [thumbSelector]
  */

diff --git a/src/js/util/util.js b/src/js/util/util.js
@@ -192,7 +192,7 @@ export function specialKeyUsed(e) {
 /**
  * Parse `gallery` or `children` options.
  *
- * @param {HTMLElement | NodeListOf<HTMLElement> | string} option
+ * @param {import('../photoswipe.js').ElementProvider} option
  * @param {string=} legacySelector
  * @param {HTMLElement | Document} [parent]
  * @returns HTMLElement[]