foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-02 17:01:14 -05:00
Code Issues Packages 1 Wiki Activity

docs: document and add examples of expandGlob (#6404)

Browse source
This commit is contained in:
Yoshiya Hinosawa 2020-06-21 03:34:28 +09:00 committed by GitHub
parent 3c58767831
commit c0ea9a99c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
std/fs/README.md
View file

@ -196,3 +196,28 @@ import {
writeFileStr("./target.dat", "file content"); // returns a promise
writeFileStrSync("./target.dat", "file content"); // void
```
### expandGlob
Expand the glob string from the specified `root` directory and yield each result
as a `WalkEntry` object.
```ts
import { expandGlob } from "https://deno.land/std/fs/mod.ts";
for await (const file of expandGlob("**/*.ts")) {
console.log(file);
}
```
### expandGlobSync
Synchronous version of `expandGlob()`.
```ts
import { expandGlobSync } from "https://deno.land/std/fs/mod.ts";
for (const file of expandGlobSync("**/*.ts")) {
console.log(file);
}
```

16
std/fs/expand_glob.ts
View file

@ -62,6 +62,12 @@ function comparePath(a: WalkEntry, b: WalkEntry): number {
/**
* Expand the glob string from the specified `root` directory and yield each
* result as a `WalkEntry` object.
*
* Examples:
*
* for await (const file of expandGlob("**\/*.ts")) {
* console.log(file);
* }
*/
export async function* expandGlob(
glob: string,
@ -161,7 +167,15 @@ export async function* expandGlob(
yield* currentMatches;
}
/** Synchronous version of `expandGlob()`. */
/**
* Synchronous version of `expandGlob()`.
*
* Examples:
*
* for (const file of expandGlobSync("**\/*.ts")) {
* console.log(file);
* }
*/
export function* expandGlobSync(
glob: string,
{