Skip to content

Commit 2a0e3e2

Browse files
committed
src/files/glob-source jsdocs with tsc-supported @return instead of @yields
1 parent b319e67 commit 2a0e3e2

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/files/glob-source.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,12 @@ const errCode = require('err-code')
1818
* @param {boolean} [options.preserveMtime] - preserve mtime
1919
* @param {number} [options.mode] - mode to use - if preserveMode is true this will be ignored
2020
* @param {import('ipfs-unixfs').MtimeLike} [options.mtime] - mtime to use - if preserveMtime is true this will be ignored
21-
* @yields {Object} File objects in the form `{ path: String, content: AsyncIterator<Buffer> }`
21+
* @return {AsyncGenerator<{
22+
* path: string;
23+
* content: AsyncIterable<Buffer> | undefined;
24+
* mode: number | undefined;
25+
* mtime: import("ipfs-unixfs/types/src/types").MtimeLike | undefined;
26+
* }, void, unknown>} File objects that match glob
2227
*/
2328
module.exports = async function * globSource (cwd, pattern, options) {
2429
options = options || {}

0 commit comments

Comments
 (0)