README

docker-image-not-found

If you want to do something only if the Docker Hub does not have an image

Only exits with 0 if the Docker registry positively responds with "image not found" response. Any other response (found, network error, etc) will exit with 1.

Use

Image does not exist

npx docker-image-not-found --repo cypress/base:nope
got an error fetching info about Docker image docker.io/cypress/base:nope
Got definite NotFoundError
exiting with code 0

The only case when this script exits with 0

Image exists

npx docker-image-not-found --repo cypress/base:8.9.3
found image docker.io/cypress/base:8.9.3
exiting with code 1

Network is down

$ ./bin/docker-image-not-found docker-image-not-found --repo cypress/base:nope
got an error fetching info about Docker image docker.io/cypress/base:nope
got an error other than image not found
Error: getaddrinfo ENOTFOUND registry-1.docker.io
    at GetAddrInfoReqWrap.onlookup [as oncomplete] (dns.js:60:26) {
  [stack]: 'Error: getaddrinfo ENOTFOUND registry-1.docker.io\n' +
    '    at GetAddrInfoReqWrap.onlookup [as oncomplete] (dns.js:60:26)',
  [message]: 'getaddrinfo ENOTFOUND registry-1.docker.io',
  errno: 'ENOTFOUND',
  code: 'ENOTFOUND',
  syscall: 'getaddrinfo',
  hostname: 'registry-1.docker.io'
}
exiting with code 1

API

To use this utility as a module

dockerImageNotFound

const di = require('docker-image-not-found')
const notFound = await di.dockerImageNotFound('image name')
// notFound is true only if the registry has responded with "NotFound"

listTags

Returns list of tags

const di = require('docker-image-not-found')
await di.listTags('cypress/included')
{
  name: 'cypress/included',
  tags: [
    '3.2.0', '3.3.0', '3.3.1',
    '3.3.2', '3.4.0', '3.4.1',
    '3.5.0', '3.6.0', '3.6.1',
    '3.7.0', '3.8.0', '3.8.1',
    '3.8.2', '3.8.3', '4.0.0',
    '4.0.1', '4.0.2', '4.1.0'
  ]
}

Misc

Debugging

Run this tool with DEBUG=docker-image-not-found environment variable to see additional debug logs

Usage no npm install needed!