Gathering detailed insights and metrics for dockerode-utils
Gathering detailed insights and metrics for dockerode-utils
Set of useful functions for working with dockerode
Installations
npm install dockerode-utilsDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
8.0.0
NPM Version
5.3.0
Score
84.2
Supply Chain
99.5
Quality
77.8
Maintenance
100
Vulnerability
99.6
License
Releases
Unable to fetch releases
Languages
1
TypeScript
TypeScript (100%)
Developer
dderevjanik
Download Statistics
Total Downloads
559,312
Last Day
135
Last Week
3,101
Last Month
10,952
Last Year
120,983
GitHub Statistics
MIT License
5 Stars
17 Commits
1 Forks
3 Watchers
2 Branches
2 Contributors
Updated on Apr 30, 2024
Bundle Size
1.58 kB
Minified
869.00 B
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
0.0.7
Package Id
dockerode-utils@0.0.7
Size
7.63 kB
NPM Version
5.3.0
Node Version
8.0.0
Total Downloads
Cumulative downloads
Total Downloads
559,312
Last Day
-22%
135
Compared to previous day
Last Week
26.9%
3,101
Compared to previous week
Last Month
33.2%
10,952
Compared to previous month
Last Year
12.9%
120,983
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
7
Dockerode Utils
Set of useful functions for working with dockerode.
TOC
- Installation
- API
- pullImageAsync pull docker image and wait to finish download. You can track progress.
- execCommand execute shell command inside a running container, returns output.
- waitForOutput wait for specific string to appear in running container's
stdout. - imageExists check if image with imageName already exists.
- Contribution
Installation
npm
1npm install dockerode-utils --save
yarn
1yarn add dockerode-utils
API
pullImageAsync(dockerode, imageName, onProgress?)
1pullImageAsync(dockerode: Dockerode, imageName: string, onProgress?: (output: string) => void): void
Will pull docker image, you can wait for finish or track a progress. If you forget to specify
:tag, it'll download :latest
1/** 2 * Example how to pull alpine:latest image from dockerhub 3 */ 4import * as Dockerode from 'dockerode'; 5import { pullImageAsync } from 'dockerode-utils'; 6 7const dockerode = new Dockerode(); 8await pullImageAsync(dockerode, 'alpine:latest');
execCommand(container, cmd)
1execCommand(container: Dockerode.Container, cmd: string[]): string[]
Execute shell command in container and returns output as string[].
1/** 2 * Print list of env from docker container 3 */ 4import * as Dockerode from 'dockerode'; 5import { execCommand } from 'dockerode-utils'; 6 7// first, we need to create a container 8const dockerode = new Dockerode(); 9const alpineContainer = await dockerode.run('alpine', [], {}, null); 10 11const envList = execCommand(alpineContainer, ['env']); 12console.log(envList); 13 14// command with argument 15const envList2 = execCommand(alpineContainer, ['env', '--help']); 16console.log(envList2);
waitForOutput(container, predicate, timeout = 15000)
1waitForOutput(container: Dockerode.Container, predicate: (output: string) => boolean, timeout: number = 15000)
Wait for specific output from container. Useful, when you're working with container, in which is running daemon and you have to wait for specific output/line to appears in container.
1/** 2 * Example with waiting for specific output. 3 * Here, we're waiting for 'InnoDB: 5.7.18 started' to appears in mysql container 4 * only after that, we know that mysql container is fully initialized and we can 5 * continue executing commands 6 */ 7 import * as Dockerode from 'dockerode'; 8 import { waitForOutput } from 'dockerode-utils'; 9 10const dockerode = new Dockerode(); 11const mysqlContainer = await dockerode.run('mysql:5.7.18', [], {}, null); 12 13await waitForOutput(mysqlContainer, (line) => line === 'InnoDB: 5.7.18 started'); 14console.log('MySql db started');
imageExists(dockerode, ...imageNames)
1imageExists(dockerode: Dockerode, ...imageNames: string | string[]): boolean
Check if images with imageNames exist. You can check more than one image at once, like imageExists(dockerode, ['mongo', 'mysql']) or only one imageExists(dockerode, 'mongo'). In case, you won't define :tag it'll check if any image with imageName prefix exists.
Contribution
Feel free to contribute with useful function that you're using daily and it can be helpful for others.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/17 approved changesets -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
63 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-pp7h-53gx-mx7r
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
- Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9vvw-cc9w-f27h
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
- Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2
- Warn: Project is vulnerable to: GHSA-q42p-pg8m-cqh6
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq
- Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm
- Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
- Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm
- Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574
- Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm
- Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-f9cm-qmx5-m98h
- Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
- Warn: Project is vulnerable to: GHSA-6394-6h9h-cfjg
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-6g33-f262-xjp4
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3
- Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7
- Warn: Project is vulnerable to: GHSA-x2mc-8fgj-3wmr
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
- Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
- Warn: Project is vulnerable to: GHSA-g7q5-pjjr-gqvp
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-06-23
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