Installations

npm install @types/klaw-sync

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Score

99.6

Supply Chain

95.9

Quality

75.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

160

Total

60,613

Closed

9,562

Merged

50,891

Issues

Open

560

Total

8,070

Closed

7,510

Releases

1

0.1.450

Published on 04 Sept 2019

View all 1 releases

Contributors

9,977

View all 9,977 contributors

Languages

3

TypeScript

JavaScript

Shell

TypeScript (99.9%)

JavaScript (0.09%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

5,488,289

Last Day

6,976

Last Week

40,785

Last Month

193,233

Last Year

2,474,035

GitHub Statistics

49,092 Stars

88,622 Commits

30,287 Forks

640 Watching

5 Branches

9,977 Contributors

Maintainers

1

Package Meta Information

Latest Version

6.0.5

Package Id

@types/klaw-sync@6.0.5

Unpacked Size

6.46 kB

Size

2.19 kB

File Count

5

Publised On

21 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

5,488,289

Last day

-12.5%

6,976

Compared to previous day

Last week

-17.7%

40,785

Compared to previous week

Last month

-2%

193,233

Compared to previous month

Last year

184.2%

2,474,035

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

@types/node

Versions

Installation

npm install --save @types/klaw-sync

Summary

This package contains type definitions for klaw-sync (https://github.com/manidlou/node-klaw-sync).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/klaw-sync.

index.d.ts

1/// <reference types="node" />
2
3import * as fs from "fs";
4declare namespace klawSync {
5    interface Item {
6        path: string;
7        stats: fs.Stats;
8    }
9
10    type Filter = (item: Item) => boolean;
11
12    interface Options {
13        /**
14         * @description True to only return files (ignore directories).
15         *              Defaults to false if not specified.
16         * @default false
17         */
18        nodir?: boolean | undefined;
19
20        /**
21         * @description True to only return directories (ignore files).
22         *              Defaults to false if not specified.
23         * @default false
24         */
25        nofile?: boolean | undefined;
26
27        /**
28         * @description The number of times to recurse before stopping.
29         *              -1 for unlimited.
30         * @default -1
31         * @since v5.0.0
32         */
33        depthLimit?: number | undefined;
34
35        /**
36         * @description Custom fs, useful when mocking fs object.
37         * @default graceful-fs
38         * @since v4.0.0
39         */
40        fs?: {
41            readdirSync(path: string): string[];
42            statSync(path: string): fs.Stats;
43        } | undefined;
44
45        /**
46         * @description function that gets one argument fn({path: '', stats: {}}) and returns true to include
47         *              or false to exclude the item
48         * @since v2.0.0
49         */
50        filter?: Filter | undefined;
51
52        /**
53         * @description traverse all subdirectories, regardless of `filter` option.
54         *
55         * When set to true, traverseAll produces similar behavior to the default
56         * behavior prior to `v4.0.0`. The current default of `traverseAll: false`
57         * is equivalent to the old `noRecurseOnFailedFilter: true`).
58         *
59         * @since v6.0.0
60         */
61        traverseAll?: boolean | undefined;
62    }
63}
64
65declare function klawSync(
66    root: string,
67    options?: klawSync.Options,
68): readonly klawSync.Item[];
69
70export = klawSync;
71

Additional Details

Last updated: Mon, 20 Nov 2023 23:36:24 GMT
Dependencies: @types/node

Credits

These definitions were written by Brendan Forster.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

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

10

Security-Policy

Determines if the project has published a security policy.

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

Code-Review

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

9

License

Determines if the project has defined a license.

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

7

/10

Last Scanned on 2025-01-27

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