npmpackage.info

@types/walk

The repository for high quality TypeScript type definitions.

2.3.4

49,120

NOASSERTION

TypeScript

6.43 kB

1,724,037 6.9

Installations

npm install @types/walk

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Pull Requests

Open

156

Total

60,646

Closed

9,570

Merged

50,920

Issues

Open

562

Total

8,073

Closed

7,511

Releases

0.1.450

Published on 04 Sept 2019

View all 1 releases

Contributors

9,978

View all 9,978 contributors

Languages

TypeScript

JavaScript

Shell

TypeScript (99.9%)

JavaScript (0.09%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

1,724,037

Last Day

542

Last Week

2,028

Last Month

9,799

Last Year

314,160

GitHub Statistics

49,120 Stars

88,652 Commits

30,294 Forks

640 Watching

5 Branches

9,978 Contributors

Maintainers

Package Meta Information

Latest Version

2.3.4

Package Id

@types/walk@2.3.4

Unpacked Size

6.43 kB

Size

2.01 kB

File Count

Publised On

07 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

1,724,037

Last day

12%

542

Compared to previous day

Last week

-19.1%

2,028

Compared to previous week

Last month

1.1%

9,799

Compared to previous month

Last year

-6.5%

314,160

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/node

Versions

Installation

npm install --save @types/walk

Summary

This package contains type definitions for walk (https://git.coolaj86.com/coolaj86/fs-walk.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/walk.

index.d.ts

1/// <reference types="node" />
2
3import { Stats } from "fs";
4
5export interface WalkStats extends Stats {
6    name: string;
7    type:
8        | "file"
9        | "directory"
10        | "symbolicLink"
11        | "blockDevice"
12        | "characterDevice"
13        | "FIFO"
14        | "socket";
15    error?: NodeJS.ErrnoException | undefined;
16}
17
18export interface WalkOptionsListeners {
19    names?: WalkNamesEventCallback | undefined;
20    files?: WalkStatArrayEventCallback | undefined;
21    file?: WalkStatEventCallback | undefined;
22    directories?: WalkStatArrayEventCallback | undefined;
23    directory?: WalkStatEventCallback | undefined;
24    end?: WalkStatArrayEventCallback | undefined;
25    errors?: WalkStatArrayEventCallback | undefined;
26    nodeError?: WalkStatArrayEventCallback | undefined;
27    directoryError?: WalkStatArrayEventCallback | undefined;
28}
29
30export interface WalkOptions {
31    followLinks?: boolean | undefined;
32    filters?: string[] | undefined;
33    listeners?: WalkOptionsListeners | undefined;
34}
35
36export type WalkNext = () => void;
37
38export type WalkStatEventCallback = (
39    base: string,
40    names: WalkStats,
41    next: WalkNext,
42) => void;
43
44export type WalkStatArrayEventCallback = (
45    base: string,
46    names: WalkStats[],
47    next: WalkNext,
48) => void;
49
50export type WalkNamesEventCallback = (
51    base: string,
52    names: string[],
53    next: WalkNext,
54) => void;
55
56export type WalkStatArrayEvent =
57    | "files"
58    | "directories"
59    | "errors"
60    | "nodeError"
61    | "directoryError";
62
63export type WalkStatEvent = "file" | "directory";
64
65export interface Walker {
66    on(event: "names", cb: WalkNamesEventCallback): void;
67    on(event: WalkStatArrayEvent, cb: WalkStatArrayEventCallback): void;
68    on(event: WalkStatEvent, cb: WalkStatEventCallback): void;
69    on(event: "end", cb: () => void): void;
70    pause(): void;
71    resume(): void;
72}
73
74export function walk(path: string, options?: WalkOptions): Walker;
75export function walkSync(path: string, options?: WalkOptions): Walker;
76

Additional Details

Last updated: Tue, 07 Nov 2023 15:11:36 GMT
Dependencies: @types/node

Credits

These definitions were written by Pontus Östlund.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.9

/10

Last Scanned on 2025-02-03

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @types/walk

@types/ignore-walk

4.0.3

TypeScript definitions for ignore-walk

@types/babylon-walk

3.10.5

TypeScript definitions for babylon-walk

@types/esprima-walk

0.1.5

TypeScript definitions for esprima-walk

@types/walk-asyncgen

0.0.2

TypeScript definitions for walk-asyncgen