Skip to content

fix: swap @yields for @returns #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 19, 2022
Merged

fix: swap @yields for @returns #178

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2a0e3e2
src/files/glob-source jsdocs with tsc-supported @return instead of @y…
gobengo Apr 11, 2022
f80ae70
glob-source returns type AsyncIterable, not AsyncGenerator
gobengo Apr 12, 2022
a06c92b
Revert "glob-source returns type AsyncIterable, not AsyncGenerator"
gobengo Apr 12, 2022
be69ab0
lint fix
gobengo Apr 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/files/glob-source.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@ const errCode = require('err-code')
* @param {boolean} [options.preserveMtime] - preserve mtime
* @param {number} [options.mode] - mode to use - if preserveMode is true this will be ignored
* @param {import('ipfs-unixfs').MtimeLike} [options.mtime] - mtime to use - if preserveMtime is true this will be ignored
* @yields {Object} File objects in the form `{ path: String, content: AsyncIterator<Buffer> }`
* @return {AsyncGenerator<{
* path: string;
* content: AsyncIterable<Buffer> | undefined;
* mode: number | undefined;
* mtime: import("ipfs-unixfs/types/src/types").MtimeLike | undefined;
* }, void, unknown>} File objects that match glob
*/
module.exports = async function * globSource (cwd, pattern, options) {
options = options || {}
Expand Down