smtpapi - npm Package Compare versions
Comparing version 1.4.3 to 1.4.4
| # Change Log | ||
| All notable changes to this project will be documented in this file. | ||
| [2020-09-02] Version 1.4.4 | ||
| -------------------------- | ||
| **Library - Docs** | ||
| - [PR #84](https://github.com/sendgrid/smtpapi-nodejs/pull/84): Ran .md files through Grammer.ly. Thanks to [@adamk1230](https://github.com/adamk1230)! | ||
| [2020-08-19] Version 1.4.3 | ||
@@ -65,3 +71,3 @@ -------------------------- | ||
| ### Fixed | ||
| - #16 fix issue where concat was used incorrectly | ||
| - #16 Fixed issue where concat was used incorrectly. | ||
| - Thanks to [Limian Wang](https://github.com/limianwang) for the PR! | ||
@@ -71,3 +77,3 @@ | ||
| ### Added | ||
| - #19 Adds setBatchId method | ||
| - #19 Adds setBatchId method. | ||
| - Thanks to [mell0kat](https://github.com/mell0kat) for the PR! | ||
@@ -74,0 +80,0 @@ |
@@ -1,2 +0,2 @@ | ||
| Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies. | ||
| Hello! Thank you for choosing to help contribute to one of the SendGrid open source libraries. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies. | ||
@@ -12,4 +12,2 @@ - [Feature Request](#feature-request) | ||
| We use [Milestones](https://github.com/sendgrid/smtpapi-nodejs/milestones) to help define current roadmaps, please feel free to grab an issue from the current milestone. Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged. | ||
| <a name="feature-request"></a> | ||
@@ -35,3 +33,3 @@ ## Feature Request | ||
| 1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post. | ||
| 2. Update to the latest version of this code and check if issue has already been fixed | ||
| 2. Update to the latest version of this code and check if the issue has already been fixed | ||
| 3. Copy and fill in the Bug Report Template we have provided below | ||
@@ -48,7 +46,7 @@ | ||
| ### Development Environment ### | ||
| ### Development Environment | ||
| #### Install and Run Locally #### | ||
| #### Install and Run Locally | ||
| ##### Prerequisites ##### | ||
| ##### Prerequisites | ||
@@ -59,3 +57,3 @@ - Node.js version 0.10, 0.12 or 4 | ||
| ##### Initial setup: ##### | ||
| ##### Initial setup: | ||
@@ -81,3 +79,3 @@ ```bash | ||
| ##### Execute: ##### | ||
| ##### Execute: | ||
@@ -185,3 +183,3 @@ See the [examples folder](examples) to get started quickly. | ||
| 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) | ||
| with a clear title and description against the `main` branch. All tests must be passing before we will review the PR. | ||
| with a clear title and description against the `main` branch. All tests must be passing before we will review the PR. | ||
@@ -188,0 +186,0 @@ <a name="code-reviews"></a> |
| { | ||
| "name": "smtpapi", | ||
| "version": "1.4.3", | ||
| "version": "1.4.4", | ||
| "description": "Build SendGrid X-SMTPAPI headers in nodejs.", | ||
@@ -5,0 +5,0 @@ "main": "lib/main.js", |
@@ -21,3 +21,2 @@  | ||
| - [Library Usage Documentation](USAGE.md) | ||
| - [Roadmap](#roadmap) | ||
| - [How to Contribute](#contribute) | ||
@@ -46,3 +45,3 @@ - [About](#about) | ||
| The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x therefore you likely already have it. | ||
| The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x, therefore, you likely already have it. | ||
@@ -63,6 +62,6 @@ Install smtpapi-nodejs and its dependencies: | ||
| ```javascript | ||
| var smtpapi = require('smtpapi'); | ||
| var header = new smtpapi(); | ||
| header.addTo('test@example.com'); | ||
| header.setUniqueArgs({cow: 'chicken'}); | ||
| var smtpapi = require("smtpapi"); | ||
| var header = new smtpapi(); | ||
| header.addTo("test@example.com"); | ||
| header.setUniqueArgs({ cow: "chicken" }); | ||
| console.log(header.jsonString()); | ||
@@ -74,7 +73,2 @@ ``` | ||
| <a name="roadmap"></a> | ||
| # Roadmap | ||
| If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/smtpapi-nodejs/milestones). We would love to hear your feedback. | ||
| <a name="contribute"></a> | ||
@@ -81,0 +75,0 @@ # How to Contribute |
@@ -8,5 +8,6 @@ If you have a non-library SendGrid issue, please contact our [support team](https://support.sendgrid.com). | ||
| * [Versions](#versions) | ||
| * [Using the Package Manager](#package-manager) | ||
| * [Viewing the Request Body](#stmpapi-header) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Versions](#versions) | ||
| - [Using the Package Manager](#using-the-package-manager) | ||
| - [Outputting the STMPAPI Header](#outputting-the-stmpapi-header) | ||
@@ -16,3 +17,3 @@ <a name="versions"></a> | ||
| We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) section. | ||
| We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) section. | ||
@@ -62,2 +63,2 @@ <a name="package-manager"></a> | ||
| } | ||
| ``` | ||
| ``` |
| # Documentation | ||
| If you would like to auto-generate documentation of the packages, you can do so locally by running: | ||
| ``` | ||
| ./node_modules/.bin/esdoc | ||
| ``` | ||
| Using the .esdoc.json file, esdoc will create documentation in the docs directory. | ||
@@ -13,4 +15,5 @@ | ||
| # More information | ||
| # More information | ||
| - [SendGrid Docs](https://sendgrid.com/docs/API_Reference/SMTP_API/index.html) | ||
| - [Example Code](examples) |
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.25%
195303
- Number of lines in readme file
- decreased by-6%
94
No dependency changes