From 2e06cd64e403836a1a5a3a21497ff55bc4c9d8a0 Mon Sep 17 00:00:00 2001 From: Ben North Date: Sun, 4 Sep 2022 13:50:15 +0100 Subject: [PATCH] Clarify documentation for forEach() Saying "at" this folder level could be taken as meaning *exactly* at that level, i.e., not descending into subfolders. The forEach() method does in fact descend, so say "at or below". --- documentation/api_jszip/for_each.md | 2 +- index.d.ts | 2 +- lib/object.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/api_jszip/for_each.md b/documentation/api_jszip/for_each.md index a3ef55f0..5f5200d0 100644 --- a/documentation/api_jszip/for_each.md +++ b/documentation/api_jszip/for_each.md @@ -4,7 +4,7 @@ layout: default section: api --- -Call a callback function for each entry at this folder level. +Call a callback function for each entry at or below this folder level. __Returns__ : Nothing. diff --git a/index.d.ts b/index.d.ts index b1c93082..7bc3e0aa 100644 --- a/index.d.ts +++ b/index.d.ts @@ -253,7 +253,7 @@ interface JSZip { folder(name: RegExp): JSZip.JSZipObject[]; /** - * Call a callback function for each entry at this folder level. + * Call a callback function for each entry at or below this folder level. * * @param callback function */ diff --git a/lib/object.js b/lib/object.js index 0e979778..8d8e8d2c 100644 --- a/lib/object.js +++ b/lib/object.js @@ -172,7 +172,7 @@ var out = { /** - * Call a callback function for each entry at this folder level. + * Call a callback function for each entry at or below this folder level. * @param {Function} cb the callback function: * function (relativePath, file) {...} * It takes 2 arguments : the relative path and the file.