@sphido/core 2.0.8 → 2.0.9

package/lib/all-pages.js

@@ -1,6 +1,9 @@
 /**
  * Page generator that flatten pages structure
+ *
+ * @generator
  * @param {array} pages
+ * @yields {name:string, path:string} next page in pages list
  */
 export function * allPages(pages) {
 	for (const page of pages) {

package/lib/copy-file.js

@@ -5,8 +5,8 @@ import {dirname} from 'node:path';
 /**
  * Write content to the file and create directory if not exists
  *
- * @param {string} file
- * @param {string} content
+ * @param {string} src
+ * @param {string} dest
  * @returns {Promise<*>}
  */
 export async function copyFile(src, dest) {

package/lib/get-pages.js

@@ -5,9 +5,9 @@ import {isPage} from './is-page.js';
 /**
  * Retrieve an array tree of pages from path
  * @param {string} path
- * @param {Function} include
- * @param extenders
- * @returns {Promise<Awaited<unknown>[{name, path}]>}
+ * @param {function(dirent:Dirent, path:string)} include
+ * @param {Object|function(page:{name:string, path:string}, dirent:Dirent, path:string)} extenders
+ * @returns {Promise<Awaited<unknown>[{name:string, path:string}]>}
  */
 export async function getPages({path = 'content', include = isPage} = {}, ...extenders) {
 	const dir = await readdir(path, {withFileTypes: true});

package/lib/is-page.js

@@ -7,7 +7,6 @@
  * - accept only *.html and *.md files
  *
  * @param {Dirent} dirent
- * @param {string} path
  * @returns {boolean}
  */
 export function isPage(dirent) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sphido/core",
-	"version": "2.0.8",
+	"version": "2.0.9",
 	"author": {
 		"name": "Roman Ožana",
 		"email": "roman@ozana.cz",
@@ -45,5 +45,5 @@
 			"no-await-in-loop": 0
 		}
 	},
-	"gitHead": "824894e08a8007b0c36d75fe005b153ccfa7c5fc"
+	"gitHead": "5ede811c6442f334f5dd04f0d146b49fc7a785ad"
 }