Skip to content

[@types/dockerode] Improve AuthConfig and pull() types #69385

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
typescript-bot merged 2 commits into from
Apr 30, 2024
Merged

[@types/dockerode] Improve AuthConfig and pull() types #69385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
601ddba
[@types/dockerode] Improve AuthConfig and pull() types
nwalters512 Apr 17, 2024
0146e70
Update callback-based pull() as well
nwalters512 Apr 17, 2024
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
11 changes: 11 additions & 0 deletions types/dockerode/dockerode-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,17 @@ docker.listServices({ filters: { name: ["network-name"] } }).then(services => {
return services.map(service => docker.getService(service.ID));
});

(async () => {
// $ExpectType ReadableStream
const pullStream = await docker.pull("hello-world", { authconfig: { username: "username", password: "password" } });

// $ExpectType Image
const pushImage = docker.getImage("hello-world");

// $ExpectType ReadableStream
const pushStream = await pushImage.push({ authconfig: { username: "username", password: "password" } });
});

const image = docker.getImage("imageName");
image.remove({ force: true, noprune: false, abortSignal: new AbortController().signal }, (err, response) => {
// NOOP;
Expand Down
14 changes: 9 additions & 5 deletions types/dockerode/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -999,9 +999,13 @@ declare namespace Dockerode {
}

interface AuthConfig {
username: string;
password: string;
serveraddress: string;
username?: string;
password?: string;
auth?: string;
serveraddress?: string;
identitytoken?: string;
registrytoken?: string;
/** @deprecated */
email?: string | undefined;
}

Expand Down Expand Up @@ -2124,8 +2128,8 @@ declare class Dockerode {
getEvents(callback: Callback<NodeJS.ReadableStream>): void;
getEvents(options?: Dockerode.GetEventsOptions): Promise<NodeJS.ReadableStream>;

pull(repoTag: string, options: {}, callback: Callback<any>, auth?: {}): Dockerode.Image;
pull(repoTag: string, options?: {}): Promise<any>;
pull(repoTag: string, options: {}, callback: Callback<NodeJS.ReadableStream>, auth?: {}): Dockerode.Image;
pull(repoTag: string, options?: {}): Promise<NodeJS.ReadableStream>;

run(
image: string,
Expand Down