Artifact Registry: Node.js Client

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
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Artifact Registry API.
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.

Sample	Source Code	Try it
Artifact_registry.create_repository	source code
Artifact_registry.create_tag	source code
Artifact_registry.delete_package	source code
Artifact_registry.delete_repository	source code
Artifact_registry.delete_tag	source code
Artifact_registry.delete_version	source code
Artifact_registry.get_docker_image	source code
Artifact_registry.get_file	source code
Artifact_registry.get_iam_policy	source code
Artifact_registry.get_maven_artifact	source code
Artifact_registry.get_npm_package	source code
Artifact_registry.get_package	source code
Artifact_registry.get_project_settings	source code
Artifact_registry.get_python_package	source code
Artifact_registry.get_repository	source code
Artifact_registry.get_tag	source code
Artifact_registry.get_v_p_c_s_c_config	source code
Artifact_registry.get_version	source code
Artifact_registry.import_apt_artifacts	source code
Artifact_registry.import_yum_artifacts	source code
Artifact_registry.list_docker_images	source code
Artifact_registry.list_files	source code
Artifact_registry.list_maven_artifacts	source code
Artifact_registry.list_npm_packages	source code
Artifact_registry.list_packages	source code
Artifact_registry.list_python_packages	source code
Artifact_registry.list_repositories	source code
Artifact_registry.list_tags	source code
Artifact_registry.list_versions	source code
Artifact_registry.set_iam_policy	source code
Artifact_registry.test_iam_permissions	source code
Artifact_registry.update_project_settings	source code
Artifact_registry.update_repository	source code
Artifact_registry.update_tag	source code
Artifact_registry.update_v_p_c_s_c_config	source code
Artifact_registry.create_repository	source code
Artifact_registry.create_tag	source code
Artifact_registry.delete_package	source code
Artifact_registry.delete_repository	source code
Artifact_registry.delete_tag	source code
Artifact_registry.delete_version	source code
Artifact_registry.get_file	source code
Artifact_registry.get_iam_policy	source code
Artifact_registry.get_package	source code
Artifact_registry.get_project_settings	source code
Artifact_registry.get_repository	source code
Artifact_registry.get_tag	source code
Artifact_registry.get_version	source code
Artifact_registry.import_apt_artifacts	source code
Artifact_registry.import_yum_artifacts	source code
Artifact_registry.list_files	source code
Artifact_registry.list_packages	source code
Artifact_registry.list_repositories	source code
Artifact_registry.list_tags	source code
Artifact_registry.list_versions	source code
Artifact_registry.set_iam_policy	source code
Artifact_registry.test_iam_permissions	source code
Artifact_registry.update_project_settings	source code
Artifact_registry.update_repository	source code
Artifact_registry.update_tag	source code
Quickstart	source code
Quickstart	source code

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