Artifact Registry: Node.js Client

release level npm version

Artifactregistry client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Artifact Registry API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/artifact-registry

Using the client library

// Imports the Google Cloud client library

// remove this line after package is released
// eslint-disable-next-line node/no-missing-require
const {ArtifactRegistryClient} = require('@google-cloud/artifact-registry');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'

// Creates a client
const client = new ArtifactRegistryClient();

//TODO(library generator): write the actual function you will be testing
async function listsRepositories() {
  const repositories = await client.listRepositories({
    parent: `projects/${projectId}/locations/${location}`,
  });
  console.info(repositories);
}
listsRepositories();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Artifact_registry.create_repositorysource codeOpen in Cloud Shell
Artifact_registry.create_tagsource codeOpen in Cloud Shell
Artifact_registry.delete_packagesource codeOpen in Cloud Shell
Artifact_registry.delete_repositorysource codeOpen in Cloud Shell
Artifact_registry.delete_tagsource codeOpen in Cloud Shell
Artifact_registry.delete_versionsource codeOpen in Cloud Shell
Artifact_registry.get_docker_imagesource codeOpen in Cloud Shell
Artifact_registry.get_filesource codeOpen in Cloud Shell
Artifact_registry.get_iam_policysource codeOpen in Cloud Shell
Artifact_registry.get_maven_artifactsource codeOpen in Cloud Shell
Artifact_registry.get_npm_packagesource codeOpen in Cloud Shell
Artifact_registry.get_packagesource codeOpen in Cloud Shell
Artifact_registry.get_project_settingssource codeOpen in Cloud Shell
Artifact_registry.get_python_packagesource codeOpen in Cloud Shell
Artifact_registry.get_repositorysource codeOpen in Cloud Shell
Artifact_registry.get_tagsource codeOpen in Cloud Shell
Artifact_registry.get_v_p_c_s_c_configsource codeOpen in Cloud Shell
Artifact_registry.get_versionsource codeOpen in Cloud Shell
Artifact_registry.import_apt_artifactssource codeOpen in Cloud Shell
Artifact_registry.import_yum_artifactssource codeOpen in Cloud Shell
Artifact_registry.list_docker_imagessource codeOpen in Cloud Shell
Artifact_registry.list_filessource codeOpen in Cloud Shell
Artifact_registry.list_maven_artifactssource codeOpen in Cloud Shell
Artifact_registry.list_npm_packagessource codeOpen in Cloud Shell
Artifact_registry.list_packagessource codeOpen in Cloud Shell
Artifact_registry.list_python_packagessource codeOpen in Cloud Shell
Artifact_registry.list_repositoriessource codeOpen in Cloud Shell
Artifact_registry.list_tagssource codeOpen in Cloud Shell
Artifact_registry.list_versionssource codeOpen in Cloud Shell
Artifact_registry.set_iam_policysource codeOpen in Cloud Shell
Artifact_registry.test_iam_permissionssource codeOpen in Cloud Shell
Artifact_registry.update_project_settingssource codeOpen in Cloud Shell
Artifact_registry.update_repositorysource codeOpen in Cloud Shell
Artifact_registry.update_tagsource codeOpen in Cloud Shell
Artifact_registry.update_v_p_c_s_c_configsource codeOpen in Cloud Shell
Artifact_registry.create_repositorysource codeOpen in Cloud Shell
Artifact_registry.create_tagsource codeOpen in Cloud Shell
Artifact_registry.delete_packagesource codeOpen in Cloud Shell
Artifact_registry.delete_repositorysource codeOpen in Cloud Shell
Artifact_registry.delete_tagsource codeOpen in Cloud Shell
Artifact_registry.delete_versionsource codeOpen in Cloud Shell
Artifact_registry.get_filesource codeOpen in Cloud Shell
Artifact_registry.get_iam_policysource codeOpen in Cloud Shell
Artifact_registry.get_packagesource codeOpen in Cloud Shell
Artifact_registry.get_project_settingssource codeOpen in Cloud Shell
Artifact_registry.get_repositorysource codeOpen in Cloud Shell
Artifact_registry.get_tagsource codeOpen in Cloud Shell
Artifact_registry.get_versionsource codeOpen in Cloud Shell
Artifact_registry.import_apt_artifactssource codeOpen in Cloud Shell
Artifact_registry.import_yum_artifactssource codeOpen in Cloud Shell
Artifact_registry.list_filessource codeOpen in Cloud Shell
Artifact_registry.list_packagessource codeOpen in Cloud Shell
Artifact_registry.list_repositoriessource codeOpen in Cloud Shell
Artifact_registry.list_tagssource codeOpen in Cloud Shell
Artifact_registry.list_versionssource codeOpen in Cloud Shell
Artifact_registry.set_iam_policysource codeOpen in Cloud Shell
Artifact_registry.test_iam_permissionssource codeOpen in Cloud Shell
Artifact_registry.update_project_settingssource codeOpen in Cloud Shell
Artifact_registry.update_repositorysource codeOpen in Cloud Shell
Artifact_registry.update_tagsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Artifact Registry Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/artifact-registry@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE