@google-cloud/common

What is @google-cloud/common?

@google-cloud/common is a library that provides common functionality for Google Cloud Node.js client libraries. It includes utilities for logging, error handling, and making authenticated API requests.

What are @google-cloud/common's main functionalities?

Logging

The logging feature allows you to create and use a logger to log messages at different levels (info, error, etc.).

const { logger } = require('@google-cloud/common');
const log = logger();
log.info('This is an info message');
log.error('This is an error message');

Error Handling

The error handling feature provides a standardized way to create and handle API errors.

const { ApiError } = require('@google-cloud/common');
try {
  throw new ApiError({ message: 'An error occurred', code: 500 });
} catch (err) {
  console.error(err.message); // 'An error occurred'
  console.error(err.code); // 500
}

Authenticated API Requests

This feature allows you to make authenticated API requests to Google Cloud services.

const { Service } = require('@google-cloud/common');
const service = new Service({
  baseUrl: 'https://example.googleapis.com',
  scopes: ['https://www.googleapis.com/auth/cloud-platform']
});
service.request({
  method: 'GET',
  uri: '/v1/resource'
}, (err, response) => {
  if (err) {
    console.error(err);
  } else {
    console.log(response);
  }
});

Other packages similar to @google-cloud/common

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides similar functionality for making HTTP requests but does not include built-in support for Google Cloud authentication.

winston

Winston is a versatile logging library for Node.js. It offers more advanced logging features compared to @google-cloud/common but does not include other utilities like error handling or authenticated requests.

request

Request is a simplified HTTP client for Node.js. It provides similar functionality for making HTTP requests but is now deprecated in favor of more modern alternatives like axios.

README

Google Cloud Common Module: Node.js Client

Node.js Common package

Google Cloud Common node.js module contains stuff used by other Cloud API modules.

• github.com/googlecloudplatform/google-cloud-node

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
  • Installing the client library
  • Using the client library
• Versioning
• Contributing
• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.

   Go to the projects page

2. Enable billing for your project.

   Enable billing

3. Set up authentication with a service account so you can access the API from your local workstation.

Installing the package

npm install --save @google-cloud/common

It's unlikely you will need to install this package directly, as it will be installed as a dependency when you install other @google-cloud packages.

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

Changelog

v0.28.0

12-13-2018 14:34 PST

This release has breaking changes. The signature of the protected request method on ServiceObject has been changed. The method now resolves with an array of [Body, Response], making it consistent with all other promisified methods. This change was made to fix several breaking changes that occurred in the 0.18.0 release.

New Features

• feat: allow passing GoogleAuth client to Service (#314)
• feat: add maybeOptionsOrCallback util method (#315)

Bug Fixes

• fix: revert async behavior of request (#331)

Documentation

• docs: update readme badges (#316)

Internal / Testing Changes

• chore(deps): update dependency @types/sinon to v7 (#332)
• chore(build): inject yoshi automation key (#330)
• chore: update nyc and eslint configs (#329)
• chore: fix publish.sh permission +x (#327)
• fix(build): fix Kokoro release script (#326)
• build: add Kokoro configs for autorelease (#325)
• chore: always nyc report before calling codecov (#322)
• chore: nyc ignore build/test by default (#321)
• chore(build): update the prettier config (#319)
• chore: update license file (#318)
• fix(build): fix system key decryption (#313)
• chore(deps): update dependency @types/sinon to v5.0.7 (#308)
• chore(deps): update dependency typescript to ~3.2.0 (#312)