1 | # Installation
|
2 | > `npm install --save @types/walk`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for walk (https://git.coolaj86.com/coolaj86/fs-walk.js).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/walk.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/walk/index.d.ts)
|
10 | ````ts
|
11 | /// <reference types="node" />
|
12 |
|
13 | import { Stats } from "fs";
|
14 |
|
15 | export interface WalkStats extends Stats {
|
16 | name: string;
|
17 | type:
|
18 | | "file"
|
19 | | "directory"
|
20 | | "symbolicLink"
|
21 | | "blockDevice"
|
22 | | "characterDevice"
|
23 | | "FIFO"
|
24 | | "socket";
|
25 | error?: NodeJS.ErrnoException | undefined;
|
26 | }
|
27 |
|
28 | export interface WalkOptionsListeners {
|
29 | names?: WalkNamesEventCallback | undefined;
|
30 | files?: WalkStatArrayEventCallback | undefined;
|
31 | file?: WalkStatEventCallback | undefined;
|
32 | directories?: WalkStatArrayEventCallback | undefined;
|
33 | directory?: WalkStatEventCallback | undefined;
|
34 | end?: WalkStatArrayEventCallback | undefined;
|
35 | errors?: WalkStatArrayEventCallback | undefined;
|
36 | nodeError?: WalkStatArrayEventCallback | undefined;
|
37 | directoryError?: WalkStatArrayEventCallback | undefined;
|
38 | }
|
39 |
|
40 | export interface WalkOptions {
|
41 | followLinks?: boolean | undefined;
|
42 | filters?: string[] | undefined;
|
43 | listeners?: WalkOptionsListeners | undefined;
|
44 | }
|
45 |
|
46 | export type WalkNext = () => void;
|
47 |
|
48 | export type WalkStatEventCallback = (
|
49 | base: string,
|
50 | names: WalkStats,
|
51 | next: WalkNext,
|
52 | ) => void;
|
53 |
|
54 | export type WalkStatArrayEventCallback = (
|
55 | base: string,
|
56 | names: WalkStats[],
|
57 | next: WalkNext,
|
58 | ) => void;
|
59 |
|
60 | export type WalkNamesEventCallback = (
|
61 | base: string,
|
62 | names: string[],
|
63 | next: WalkNext,
|
64 | ) => void;
|
65 |
|
66 | export type WalkStatArrayEvent =
|
67 | | "files"
|
68 | | "directories"
|
69 | | "errors"
|
70 | | "nodeError"
|
71 | | "directoryError";
|
72 |
|
73 | export type WalkStatEvent = "file" | "directory";
|
74 |
|
75 | export interface Walker {
|
76 | on(event: "names", cb: WalkNamesEventCallback): void;
|
77 | on(event: WalkStatArrayEvent, cb: WalkStatArrayEventCallback): void;
|
78 | on(event: WalkStatEvent, cb: WalkStatEventCallback): void;
|
79 | on(event: "end", cb: () => void): void;
|
80 | pause(): void;
|
81 | resume(): void;
|
82 | }
|
83 |
|
84 | export function walk(path: string, options?: WalkOptions): Walker;
|
85 | export function walkSync(path: string, options?: WalkOptions): Walker;
|
86 |
|
87 | ````
|
88 |
|
89 | ### Additional Details
|
90 | * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
|
91 | * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
|
92 |
|
93 | # Credits
|
94 | These definitions were written by [Pontus Östlund](https://github.com/poppa).
|
95 |
|
\ | No newline at end of file |