@google-cloud/kms
Advanced tools
Comparing version 2.1.2 to 2.1.3
| import * as v1 from './v1'; | ||
| declare const KeyManagementServiceClient: typeof v1.KeyManagementServiceClient; | ||
| declare type KeyManagementServiceClient = v1.KeyManagementServiceClient; | ||
| export { v1, KeyManagementServiceClient }; | ||
@@ -4,0 +5,0 @@ declare const _default: { |
@@ -44,4 +44,6 @@ /// <reference types="node" /> | ||
| * | ||
| * @param {object} [options] - The configuration object. See the subsequent | ||
| * parameters for more details. | ||
| * @param {object} [options] - The configuration object. | ||
| * The options accepted by the constructor are described in detail | ||
| * in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance). | ||
| * The common options are: | ||
| * @param {object} [options.credentials] - Credentials object. | ||
@@ -66,2 +68,9 @@ * @param {string} [options.credentials.client_email] | ||
| * API remote host. | ||
| * @param {gax.ClientConfig} [options.clientConfig] - client configuration override. | ||
| * TODO(@alexander-fenster): link to gax documentation. | ||
| * @param {boolean} fallback - Use HTTP fallback mode. | ||
| * In fallback mode, a special browser-compatible transport implementation is used | ||
| * instead of gRPC transport. In browser context (if the `window` object is defined) | ||
| * the fallback mode is enabled automatically; set `options.fallback` to `false` | ||
| * if you need to override this behavior. | ||
| */ | ||
@@ -85,2 +94,3 @@ constructor(opts?: ClientOptions); | ||
| * The DNS address for this API service. | ||
| * @returns {string} The DNS address for this service. | ||
| */ | ||
@@ -91,2 +101,3 @@ static get servicePath(): string; | ||
| * exists for compatibility reasons. | ||
| * @returns {string} The DNS address for this service. | ||
| */ | ||
@@ -96,2 +107,3 @@ static get apiEndpoint(): string; | ||
| * The port for this API service. | ||
| * @returns {number} The default port for this service. | ||
| */ | ||
@@ -102,2 +114,3 @@ static get port(): number; | ||
| * in this service. | ||
| * @returns {string[]} List of default scopes. | ||
| */ | ||
@@ -168,14 +181,3 @@ static get scopes(): string[]; | ||
| /** | ||
| * Equivalent to {@link listKeyRings}, but returns a NodeJS Stream object. | ||
| * | ||
| * This fetches the paged responses for {@link listKeyRings} continuously | ||
| * and invokes the callback registered for 'data' event for each element in the | ||
| * responses. | ||
| * | ||
| * The returned object has 'end' method when no more elements are required. | ||
| * | ||
| * autoPaginate option will be ignored. | ||
| * | ||
| * @see {@link https://nodejs.org/api/stream.html} | ||
| * | ||
| * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. | ||
| * @param {Object} request | ||
@@ -208,9 +210,15 @@ * The request object that will be sent. | ||
| * An object stream which emits an object representing [KeyRing]{@link google.cloud.kms.v1.KeyRing} on 'data' event. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed. Note that it can affect your quota. | ||
| * We recommend using `listKeyRingsAsync()` | ||
| * method described below for async iteration which you can stop as needed. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| */ | ||
| listKeyRingsStream(request?: protos.google.cloud.kms.v1.IListKeyRingsRequest, options?: gax.CallOptions): Transform; | ||
| /** | ||
| * Equivalent to {@link listKeyRings}, but returns an iterable object. | ||
| * Equivalent to `listKeyRings`, but returns an iterable object. | ||
| * | ||
| * for-await-of syntax is used with the iterable to recursively get response element on-demand. | ||
| * | ||
| * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. | ||
| * @param {Object} request | ||
@@ -242,3 +250,14 @@ * The request object that will be sent. | ||
| * @returns {Object} | ||
| * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. | ||
| * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). | ||
| * When you iterate the returned iterable, each element will be an object representing | ||
| * [KeyRing]{@link google.cloud.kms.v1.KeyRing}. The API will be called under the hood as needed, once per the page, | ||
| * so you can stop the iteration when you don't need more results. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listKeyRingsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| */ | ||
@@ -250,14 +269,3 @@ listKeyRingsAsync(request?: protos.google.cloud.kms.v1.IListKeyRingsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.cloud.kms.v1.IKeyRing>; | ||
| /** | ||
| * Equivalent to {@link listCryptoKeys}, but returns a NodeJS Stream object. | ||
| * | ||
| * This fetches the paged responses for {@link listCryptoKeys} continuously | ||
| * and invokes the callback registered for 'data' event for each element in the | ||
| * responses. | ||
| * | ||
| * The returned object has 'end' method when no more elements are required. | ||
| * | ||
| * autoPaginate option will be ignored. | ||
| * | ||
| * @see {@link https://nodejs.org/api/stream.html} | ||
| * | ||
| * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. | ||
| * @param {Object} request | ||
@@ -292,9 +300,15 @@ * The request object that will be sent. | ||
| * An object stream which emits an object representing [CryptoKey]{@link google.cloud.kms.v1.CryptoKey} on 'data' event. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed. Note that it can affect your quota. | ||
| * We recommend using `listCryptoKeysAsync()` | ||
| * method described below for async iteration which you can stop as needed. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| */ | ||
| listCryptoKeysStream(request?: protos.google.cloud.kms.v1.IListCryptoKeysRequest, options?: gax.CallOptions): Transform; | ||
| /** | ||
| * Equivalent to {@link listCryptoKeys}, but returns an iterable object. | ||
| * Equivalent to `listCryptoKeys`, but returns an iterable object. | ||
| * | ||
| * for-await-of syntax is used with the iterable to recursively get response element on-demand. | ||
| * | ||
| * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. | ||
| * @param {Object} request | ||
@@ -328,3 +342,14 @@ * The request object that will be sent. | ||
| * @returns {Object} | ||
| * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. | ||
| * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). | ||
| * When you iterate the returned iterable, each element will be an object representing | ||
| * [CryptoKey]{@link google.cloud.kms.v1.CryptoKey}. The API will be called under the hood as needed, once per the page, | ||
| * so you can stop the iteration when you don't need more results. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listCryptoKeysAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| */ | ||
@@ -336,14 +361,3 @@ listCryptoKeysAsync(request?: protos.google.cloud.kms.v1.IListCryptoKeysRequest, options?: gax.CallOptions): AsyncIterable<protos.google.cloud.kms.v1.ICryptoKey>; | ||
| /** | ||
| * Equivalent to {@link listCryptoKeyVersions}, but returns a NodeJS Stream object. | ||
| * | ||
| * This fetches the paged responses for {@link listCryptoKeyVersions} continuously | ||
| * and invokes the callback registered for 'data' event for each element in the | ||
| * responses. | ||
| * | ||
| * The returned object has 'end' method when no more elements are required. | ||
| * | ||
| * autoPaginate option will be ignored. | ||
| * | ||
| * @see {@link https://nodejs.org/api/stream.html} | ||
| * | ||
| * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. | ||
| * @param {Object} request | ||
@@ -379,9 +393,15 @@ * The request object that will be sent. | ||
| * An object stream which emits an object representing [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion} on 'data' event. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed. Note that it can affect your quota. | ||
| * We recommend using `listCryptoKeyVersionsAsync()` | ||
| * method described below for async iteration which you can stop as needed. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| */ | ||
| listCryptoKeyVersionsStream(request?: protos.google.cloud.kms.v1.IListCryptoKeyVersionsRequest, options?: gax.CallOptions): Transform; | ||
| /** | ||
| * Equivalent to {@link listCryptoKeyVersions}, but returns an iterable object. | ||
| * Equivalent to `listCryptoKeyVersions`, but returns an iterable object. | ||
| * | ||
| * for-await-of syntax is used with the iterable to recursively get response element on-demand. | ||
| * | ||
| * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. | ||
| * @param {Object} request | ||
@@ -416,3 +436,14 @@ * The request object that will be sent. | ||
| * @returns {Object} | ||
| * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. | ||
| * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). | ||
| * When you iterate the returned iterable, each element will be an object representing | ||
| * [CryptoKeyVersion]{@link google.cloud.kms.v1.CryptoKeyVersion}. The API will be called under the hood as needed, once per the page, | ||
| * so you can stop the iteration when you don't need more results. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listCryptoKeyVersionsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| */ | ||
@@ -424,14 +455,3 @@ listCryptoKeyVersionsAsync(request?: protos.google.cloud.kms.v1.IListCryptoKeyVersionsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.cloud.kms.v1.ICryptoKeyVersion>; | ||
| /** | ||
| * Equivalent to {@link listImportJobs}, but returns a NodeJS Stream object. | ||
| * | ||
| * This fetches the paged responses for {@link listImportJobs} continuously | ||
| * and invokes the callback registered for 'data' event for each element in the | ||
| * responses. | ||
| * | ||
| * The returned object has 'end' method when no more elements are required. | ||
| * | ||
| * autoPaginate option will be ignored. | ||
| * | ||
| * @see {@link https://nodejs.org/api/stream.html} | ||
| * | ||
| * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object. | ||
| * @param {Object} request | ||
@@ -464,9 +484,15 @@ * The request object that will be sent. | ||
| * An object stream which emits an object representing [ImportJob]{@link google.cloud.kms.v1.ImportJob} on 'data' event. | ||
| * The client library will perform auto-pagination by default: it will call the API as many | ||
| * times as needed. Note that it can affect your quota. | ||
| * We recommend using `listImportJobsAsync()` | ||
| * method described below for async iteration which you can stop as needed. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| */ | ||
| listImportJobsStream(request?: protos.google.cloud.kms.v1.IListImportJobsRequest, options?: gax.CallOptions): Transform; | ||
| /** | ||
| * Equivalent to {@link listImportJobs}, but returns an iterable object. | ||
| * Equivalent to `listImportJobs`, but returns an iterable object. | ||
| * | ||
| * for-await-of syntax is used with the iterable to recursively get response element on-demand. | ||
| * | ||
| * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. | ||
| * @param {Object} request | ||
@@ -498,3 +524,14 @@ * The request object that will be sent. | ||
| * @returns {Object} | ||
| * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols. | ||
| * An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). | ||
| * When you iterate the returned iterable, each element will be an object representing | ||
| * [ImportJob]{@link google.cloud.kms.v1.ImportJob}. The API will be called under the hood as needed, once per the page, | ||
| * so you can stop the iteration when you don't need more results. | ||
| * Please see the | ||
| * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) | ||
| * for more details and examples. | ||
| * @example | ||
| * const iterable = client.listImportJobsAsync(request); | ||
| * for await (const response of iterable) { | ||
| * // process response | ||
| * } | ||
| */ | ||
@@ -835,7 +872,8 @@ listImportJobsAsync(request?: protos.google.cloud.kms.v1.IListImportJobsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.cloud.kms.v1.IImportJob>; | ||
| /** | ||
| * Terminate the GRPC channel and close the client. | ||
| * Terminate the gRPC channel and close the client. | ||
| * | ||
| * The client will no longer be usable and all future behavior is undefined. | ||
| * @returns {Promise} A promise that resolves when the client is closed. | ||
| */ | ||
| close(): Promise<void>; | ||
| } |
@@ -7,2 +7,9 @@ # Changelog | ||
| ### [2.1.3](https://www.github.com/googleapis/nodejs-kms/compare/v2.1.2...v2.1.3) (2020-11-07) | ||
| ### Bug Fixes | ||
| * do not modify options object, use defaultScopes ([#399](https://www.github.com/googleapis/nodejs-kms/issues/399)) ([288b417](https://www.github.com/googleapis/nodejs-kms/commit/288b4172079145686ca9c129005ba27dec788712)) | ||
| ### [2.1.2](https://www.github.com/googleapis/nodejs-kms/compare/v2.1.1...v2.1.2) (2020-06-12) | ||
@@ -9,0 +16,0 @@ |
| { | ||
| "name": "@google-cloud/kms", | ||
| "description": "Google Cloud Key Management Service (KMS) API client for Node.js", | ||
| "version": "2.1.2", | ||
| "version": "2.1.3", | ||
| "license": "Apache-2.0", | ||
@@ -43,9 +43,11 @@ "author": "Google LLC", | ||
| "system-test": "c8 mocha build/system-test", | ||
| "test": "c8 mocha build/test" | ||
| "test": "c8 mocha build/test", | ||
| "api-extractor": "api-extractor run --local", | ||
| "api-documenter": "api-documenter yaml --input-folder=temp" | ||
| }, | ||
| "dependencies": { | ||
| "google-gax": "^2.1.0" | ||
| "google-gax": "^2.9.2" | ||
| }, | ||
| "devDependencies": { | ||
| "@types/mocha": "^7.0.2", | ||
| "@types/mocha": "^8.0.0", | ||
| "@types/node": "^13.13.4", | ||
@@ -63,7 +65,9 @@ "@types/sinon": "^9.0.0", | ||
| "sinon": "^9.0.1", | ||
| "ts-loader": "^7.0.0", | ||
| "ts-loader": "^8.0.0", | ||
| "typescript": "^3.8.3", | ||
| "webpack": "^4.42.0", | ||
| "webpack-cli": "^3.3.11" | ||
| "webpack": "^5.0.0", | ||
| "webpack-cli": "^4.0.0", | ||
| "@microsoft/api-documenter": "^7.8.10", | ||
| "@microsoft/api-extractor": "^7.8.10" | ||
| } | ||
| } |
@@ -17,2 +17,5 @@ [//]: # "This README.md file is auto-generated, all changes to this file will be lost." | ||
| A comprehensive list of changes in each version may be found in | ||
| [the CHANGELOG](https://github.com/googleapis/nodejs-kms/blob/master/CHANGELOG.md). | ||
| * [Google Cloud Key Management Service Node.js Client API Reference][client-docs] | ||
@@ -19,0 +22,0 @@ * [Google Cloud Key Management Service Documentation][product-docs] |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Total package byte prevSize
- increased by9.22%
2395040
- Lines of code
- increased by9.24%
37247
- Number of lines in readme file
- increased by1.52%
201
Worsened metrics
- Dev dependency count
- increased by11.76%
19
Dependency changes
Updatedgoogle-gax@^2.9.2