npmpackage.info

Gathering detailed insights and metrics for @types/dockerode-compose

@types/dockerode-compose - 1.4.1 | npmpackage.info

@types/dockerode-compose

The repository for high quality TypeScript type definitions.

1.4.1

50,033

NOASSERTION

TypeScript

5.04 kB

Installations

npm install @types/dockerode-compose

Developer Guide

BETA

Typescript

Yes

Module System

N/A

Pull Requests

Open

153

Total

61,820

Closed

9,749

Merged

51,918

Issues

Open

565

Total

8,085

Closed

7,520

Releases

0.1.450

Updated on Sep 04, 2019

View All 1 releases

Languages

TypeScript

JavaScript

Shell

TypeScript (99.84%)

JavaScript (0.15%)

Shell (0.01%)

Developer

DefinitelyTyped

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

50,033 Stars

89,737 Commits

30,434 Forks

640 Watchers

6 Branches

9,957 Contributors

Updated on Jul 14, 2025

Maintainers

View All 9,957 Contributors

Package Meta Information

Latest Version

1.4.1

Package Id

@types/dockerode-compose@1.4.1

Unpacked Size

5.04 kB

Size

1.86 kB

File Count

Published on

Feb 21, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/dockerode

Installation

npm install --save @types/dockerode-compose

Summary

This package contains type definitions for dockerode-compose (https://github.com/apocas/dockerode-compose#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/dockerode-compose.

index.d.ts

1import * as Dockerode from "dockerode";
2
3declare namespace DockerodeCompose {
4    interface ComposeDownOptions {
5        volumes: boolean;
6    }
7
8    interface ComposeDownOutput {
9        file: string;
10        services: [];
11        networks: [];
12        volumes: [] | undefined;
13    }
14
15    interface ComposeUpOptions {
16        verbose: boolean;
17    }
18
19    interface ComposeUpOutput {
20        file: string;
21        secrets: any[];
22        volumes: Dockerode.VolumeCreateResponse[];
23        configs: any[];
24        networks: Network[];
25        services: Dockerode.Container[];
26    }
27
28    interface ComposePullOptions {
29        verbose: boolean;
30        streams: boolean;
31    }
32
33    interface Network {
34        name: string;
35        network: Dockerode.Network;
36    }
37}
38
39declare class Compose {
40    constructor(dockerode: Dockerode, file: string, projectName: string);
41
42    /* @async */
43    down(options?: DockerodeCompose.ComposeDownOptions): Promise<DockerodeCompose.ComposeDownOutput>;
44
45    /* @async */
46    up(options?: DockerodeCompose.ComposeUpOptions): Promise<DockerodeCompose.ComposeUpOutput>;
47
48    /* @async */
49    pull(serviceN?: string, options?: DockerodeCompose.ComposePullOptions): Promise<any[]>;
50}
51
52export = Compose;
53

Additional Details

Last updated: Wed, 21 Feb 2024 08:08:29 GMT
Dependencies: @types/dockerode

Credits

These definitions were written by Josua Frank.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

License

Determines if the project has defined a license.

8

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7

/10

Last Scanned on 2025-07-07

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