@types/npm-packlist/README.md

TypeScript definitions for npm-packlist

# Installation
> `npm install --save @types/npm-packlist`

# Summary
This package contains type definitions for npm-packlist (https://github.com/npm/npm-packlist).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/npm-packlist.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/npm-packlist/index.d.ts)
````ts
import type { Node } from "@npmcli/arborist";
import type { Walker, WalkerOptions, WalkerSync } from "ignore-walk";

declare function packlist(tree: Node, options?: packlist.Options): Promise<string[]>;
declare function packlist<T>(
    tree: Node,
    options: packlist.Options | undefined,
    callback: (result: string[]) => T,
): Promise<T>;

declare namespace packlist {
    interface Options extends WalkerOptions {
        parent?: Walker | WalkerSync | null | undefined;
        /** Directory to walk recusively. Defaults to `process.cwd()`. */
        path?: string | undefined;
    }
}

export = packlist;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/ignore-walk](https://npmjs.com/package/@types/ignore-walk), [@types/npmcli__arborist](https://npmjs.com/package/@types/npmcli__arborist)

# Credits
These definitions were written by [Klaus Meinhardt](https://github.com/ajafff), and [Florian Imdahl](https://github.com/ffflorian).