Skip to content

docs: add example #14716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgryte merged 2 commits into from
Sep 4, 2026
Merged

docs: add example #14716

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
caa016b
docs: add examples section to `_tools/pkgs/installed` README
claude Aug 27, 2026
5140fe6
Apply batched suggestions from code review
kgryte Sep 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions lib/node_modules/@stdlib/_tools/pkgs/installed/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ var pkgs = require( '@stdlib/_tools/pkgs/installed' );

Generates a list of installed package dependencies.

<!-- run-disable -->

```javascript
pkgs( onPkgs );

Expand All @@ -59,6 +61,8 @@ The function accepts the following `options`:

By default, the function searches the entire package dependency tree. To limit the search depth, set the `depth` option.

<!-- run-disable -->

```javascript
var opts = {
'depth': 0 // search only top-level installed packages
Expand All @@ -76,6 +80,8 @@ function onPkgs( error, list ) {

To exclude development package dependencies, set the `dev` option to `false`.

<!-- run-disable -->

```javascript
var opts = {
'dev': false
Expand All @@ -97,11 +103,24 @@ function onPkgs( error, list ) {

<section class="examples">

<!-- ## Examples
## Examples

<!-- run-disable -->

<!-- eslint no-undef: "error" -->
Comment thread
kgryte marked this conversation as resolved.

```javascript
var pkgs = require( '@stdlib/_tools/pkgs/installed' );

``` javascript
pkgs( onPkgs );

``` -->
function onPkgs( error, list ) {
if ( error ) {
throw error;
}
console.dir( list );
}
```

</section>

Expand Down