Path.walk() method

pathlib-ts > Path > walk

Path.walk() method

Walk the directory tree from this directory.

Signature:

walk(options?: {
        topDown?: boolean;
    }): Promise<WalkTuple[]>;

Parameters

Parameter	Type	Description
options	{ topDown?: boolean; }	(Optional) Control for traversal order (topDown).

Returns:

Promise<WalkTuple[]>

Promise resolving to an array of WalkTuple entries.

Remarks

Returns WalkTuple entries while delegating to the synchronous walker via Promise wrapper.

Example

Copying a tree using walk

import { Path } from "pathlib-ts";

const source = new Path("./build");
const target = new Path("./public");
for (const [dir, , files] of await source.walk()) {
  const rel = dir.relativeTo(source, { walkUp: true });
  const outDir = target.joinpath(rel) as Path;
  await outDir.mkdir({ parents: true, existOk: true });
  for (const name of files) {
    await dir.joinpath(name).copy(outDir.joinpath(name));
  }
}