3.0.6 • Published 6 months ago
@types/klaw v3.0.6
Installation
npm install --save @types/klaw
Summary
This package contains type definitions for klaw (https://github.com/jprichardson/node-klaw).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/klaw.
index.d.ts
// Type definitions for klaw v3.0.0
// Project: https://github.com/jprichardson/node-klaw
// Definitions by: Matthew McEachen <https://github.com/mceachen>
// Pascal Sthamer <https://github.com/p4sca1>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference types="node" />
declare module "klaw" {
import * as fs from "fs"
import { Readable, ReadableOptions } from 'stream'
function K(root: string, options?: K.Options): K.Walker
namespace K {
interface Item {
path: string
stats: fs.Stats
}
type QueueMethod = "shift" | "pop"
interface Options extends ReadableOptions {
queueMethod?: QueueMethod | undefined
pathSorter?: ((pathA: string, pathB: string) => number) | undefined
fs?: any // fs or mock-fs
filter?: ((path: string) => boolean) | undefined
depthLimit?: number | undefined
preserveSymlinks?: boolean | undefined
}
type Event = "close" | "data" | "end" | "error" | "pause" | "readable" | "resume"
interface Walker extends Readable, AsyncIterable<Item> {
on(event: Event, listener: Function): this
on(event: "close", listener: () => void): this
on(event: "data", listener: (item: Item) => void): this
on(event: "end", listener: () => void): this
on(event: "readable", listener: () => void): this
on(event: "error", listener: (err: Error) => void): this
read(): Item
[Symbol.asyncIterator](): AsyncIterableIterator<Item>
}
}
export = K
}
Additional Details
- Last updated: Wed, 20 Oct 2021 15:31:23 GMT
- Dependencies: @types/node
- Global values: none
Credits
These definitions were written by Matthew McEachen, and Pascal Sthamer.