@google-cloud/promisify 2.0.3 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +24 -25
  3. package/package.json +10 -14
package/CHANGELOG.md CHANGED
@@ -4,6 +4,31 @@
4
4
 
5
5
  [1]: https://www.npmjs.com/package/nodejs-promisify?activeTab=versions
6
6
 
7
+ ## [3.0.1](https://github.com/googleapis/nodejs-promisify/compare/v3.0.0...v3.0.1) (2022-08-23)
8
+
9
+
10
+ ### Bug Fixes
11
+
12
+ * remove pip install statements ([#1546](https://github.com/googleapis/nodejs-promisify/issues/1546)) ([#310](https://github.com/googleapis/nodejs-promisify/issues/310)) ([c7c6883](https://github.com/googleapis/nodejs-promisify/commit/c7c688389de72ddc0181b19bceee2d95eacd3d96))
13
+
14
+ ## [3.0.0](https://github.com/googleapis/nodejs-promisify/compare/v2.0.4...v3.0.0) (2022-05-03)
15
+
16
+
17
+ ### ⚠ BREAKING CHANGES
18
+
19
+ * drop node 10 from engines list, update typescript to 4.6.3 (#300)
20
+
21
+ ### Build System
22
+
23
+ * drop node 10 from engines list, update typescript to 4.6.3 ([#300](https://github.com/googleapis/nodejs-promisify/issues/300)) ([fed2f14](https://github.com/googleapis/nodejs-promisify/commit/fed2f145a5256c939eb66b85a5c7c48332b8841d))
24
+
25
+ ### [2.0.4](https://www.github.com/googleapis/nodejs-promisify/compare/v2.0.3...v2.0.4) (2021-09-09)
26
+
27
+
28
+ ### Bug Fixes
29
+
30
+ * **build:** switch primary branch to main ([#270](https://www.github.com/googleapis/nodejs-promisify/issues/270)) ([11242f7](https://www.github.com/googleapis/nodejs-promisify/commit/11242f7f76e170dae7a429f8d4064bf33be9bb3f))
31
+
7
32
  ### [2.0.3](https://www.github.com/googleapis/nodejs-promisify/compare/v2.0.2...v2.0.3) (2020-09-04)
8
33
 
9
34
 
package/README.md CHANGED
@@ -4,9 +4,8 @@
4
4
 
5
5
  # [Google Cloud Common Promisify: Node.js Client](https://github.com/googleapis/nodejs-promisify)
6
6
 
7
- [![release level](https://img.shields.io/badge/release%20level-general%20availability%20%28GA%29-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
7
+ [![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)
8
8
  [![npm version](https://img.shields.io/npm/v/@google-cloud/promisify.svg)](https://www.npmjs.org/package/@google-cloud/promisify)
9
- [![codecov](https://img.shields.io/codecov/c/github/googleapis/nodejs-promisify/master.svg?style=flat)](https://codecov.io/gh/googleapis/nodejs-promisify)
10
9
 
11
10
 
12
11
 
@@ -15,7 +14,7 @@ A simple utility for promisifying functions and classes.
15
14
 
16
15
 
17
16
  A comprehensive list of changes in each version may be found in
18
- [the CHANGELOG](https://github.com/googleapis/nodejs-promisify/blob/master/CHANGELOG.md).
17
+ [the CHANGELOG](https://github.com/googleapis/nodejs-promisify/blob/main/CHANGELOG.md).
19
18
 
20
19
  * [Google Cloud Common Promisify Node.js Client API Reference][client-docs]
21
20
 
@@ -80,12 +79,11 @@ installed as a dependency when you install other `@google-cloud` packages.
80
79
 
81
80
  ## Samples
82
81
 
83
- Samples are in the [`samples/`](https://github.com/googleapis/nodejs-promisify/tree/master/samples) directory. The samples' `README.md`
84
- has instructions for running the samples.
82
+ Samples are in the [`samples/`](https://github.com/googleapis/nodejs-promisify/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.
85
83
 
86
84
  | Sample | Source Code | Try it |
87
85
  | --------------------------- | --------------------------------- | ------ |
88
- | Quickstart | [source code](https://github.com/googleapis/nodejs-promisify/blob/master/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-promisify&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
86
+ | Quickstart | [source code](https://github.com/googleapis/nodejs-promisify/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-promisify&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |
89
87
 
90
88
 
91
89
 
@@ -97,56 +95,57 @@ also contains samples.
97
95
  Our client libraries follow the [Node.js release schedule](https://nodejs.org/en/about/releases/).
98
96
  Libraries are compatible with all current _active_ and _maintenance_ versions of
99
97
  Node.js.
98
+ If you are using an end-of-life version of Node.js, we recommend that you update
99
+ as soon as possible to an actively supported LTS version.
100
100
 
101
- Client libraries targetting some end-of-life versions of Node.js are available, and
102
- can be installed via npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
103
- The dist-tags follow the naming convention `legacy-(version)`.
104
-
105
- _Legacy Node.js versions are supported as a best effort:_
106
-
107
- * Legacy versions will not be tested in continuous integration.
108
- * Some security patches may not be able to be backported.
109
- * Dependencies will not be kept up-to-date, and features will not be backported.
101
+ Google's client libraries support legacy versions of Node.js runtimes on a
102
+ best-efforts basis with the following warnings:
110
103
 
111
- #### Legacy tags available
104
+ * Legacy versions are not tested in continuous integration.
105
+ * Some security patches and features cannot be backported.
106
+ * Dependencies cannot be kept up-to-date.
112
107
 
113
- * `legacy-8`: install client libraries from this dist-tag for versions
114
- compatible with Node.js 8.
108
+ Client libraries targeting some end-of-life versions of Node.js are available, and
109
+ can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
110
+ The dist-tags follow the naming convention `legacy-(version)`.
111
+ For example, `npm install @google-cloud/promisify@legacy-8` installs client libraries
112
+ for versions compatible with Node.js 8.
115
113
 
116
114
  ## Versioning
117
115
 
118
116
  This library follows [Semantic Versioning](http://semver.org/).
119
117
 
120
118
 
121
- This library is considered to be **General Availability (GA)**. This means it
122
- is stable; the code surface will not change in backwards-incompatible ways
119
+
120
+ This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
123
121
  unless absolutely necessary (e.g. because of critical security issues) or with
124
- an extensive deprecation period. Issues and requests against **GA** libraries
122
+ an extensive deprecation period. Issues and requests against **stable** libraries
125
123
  are addressed with the highest priority.
126
124
 
127
125
 
128
126
 
129
127
 
130
128
 
129
+
131
130
  More Information: [Google Cloud Platform Launch Stages][launch_stages]
132
131
 
133
132
  [launch_stages]: https://cloud.google.com/terms/launch-stages
134
133
 
135
134
  ## Contributing
136
135
 
137
- Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-promisify/blob/master/CONTRIBUTING.md).
136
+ Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-promisify/blob/main/CONTRIBUTING.md).
138
137
 
139
138
  Please note that this `README.md`, the `samples/README.md`,
140
139
  and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
141
140
  are generated from a central template. To edit one of these files, make an edit
142
- to its template in this
143
- [directory](https://github.com/googleapis/synthtool/tree/master/synthtool/gcp/templates/node_library).
141
+ to its templates in
142
+ [directory](https://github.com/googleapis/synthtool).
144
143
 
145
144
  ## License
146
145
 
147
146
  Apache Version 2.0
148
147
 
149
- See [LICENSE](https://github.com/googleapis/nodejs-promisify/blob/master/LICENSE)
148
+ See [LICENSE](https://github.com/googleapis/nodejs-promisify/blob/main/LICENSE)
150
149
 
151
150
  [client-docs]: https://googleapis.dev/nodejs/promisify/latest
152
151
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-cloud/promisify",
3
- "version": "2.0.3",
3
+ "version": "3.0.1",
4
4
  "description": "A simple utility for promisifying functions and classes.",
5
5
  "main": "build/src/index.js",
6
6
  "types": "build/src/index.d.ts",
@@ -20,9 +20,7 @@
20
20
  "predocs-test": "npm run docs",
21
21
  "prelint": "cd samples; npm link ../; npm install",
22
22
  "clean": "gts clean",
23
- "precompile": "gts clean",
24
- "api-extractor": "api-extractor run --local",
25
- "api-documenter": "api-documenter yaml --input-folder=temp"
23
+ "precompile": "gts clean"
26
24
  },
27
25
  "keywords": [],
28
26
  "files": [
@@ -33,22 +31,20 @@
33
31
  "license": "Apache-2.0",
34
32
  "devDependencies": {
35
33
  "@compodoc/compodoc": "^1.1.9",
36
- "@types/mocha": "^8.0.0",
37
- "@types/node": "^10.5.2",
38
- "@types/sinon": "^9.0.0",
34
+ "@types/mocha": "^9.0.0",
35
+ "@types/node": "^17.0.25",
36
+ "@types/sinon": "^10.0.0",
39
37
  "c8": "^7.0.0",
40
38
  "chai": "^4.2.0",
41
39
  "codecov": "^3.0.4",
42
- "gts": "^2.0.0",
40
+ "gts": "^3.1.0",
43
41
  "hard-rejection": "^2.1.0",
44
- "linkinator": "^2.0.0",
42
+ "linkinator": "^4.0.0",
45
43
  "mocha": "^8.0.0",
46
- "sinon": "^9.0.0",
47
- "typescript": "^3.8.3",
48
- "@microsoft/api-documenter": "^7.8.10",
49
- "@microsoft/api-extractor": "^7.8.10"
44
+ "sinon": "^14.0.0",
45
+ "typescript": "^4.6.3"
50
46
  },
51
47
  "engines": {
52
- "node": ">=10"
48
+ "node": ">=12"
53
49
  }
54
50
  }