README.njk

{% include "module-header" %}

{%- include "installation" -%}

# Synopsis

```ts
await readPackageNames("node_modules"); // ["pg-structure", "@babel/runtime", ...]
await readPackageNames("node_modules", { scope: "babel" }); // ["@babel/runtime", "@babel/template", ...]
await readPackageNames("node_modules", { prefix: "pg" }); // ["pg-structure", "pg-generator", "@user/pg-promise", ...]
await readPackageNames("node_modules", { scope: "user", prefix: "pg" }); // ["@user/pg-promise", ...]
```

# Details

Reads all package names in a directory by reading all entries in the given directory and all sub entries in directories starting with the "@" sign.

<!-- usage -->

<!-- commands -->

# API

{% include "api.md" %}