api-response-envelope

v1.0.1

Wraps an API output response in an envelope with 'status', 'message', and 'results' keys.

NPM

README

GitHub

Website

MIT

Latest version published 5 years ago

    npm install api-response-envelope

We couldn't find any similar packages Browse all packages

Package Health Score

40 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (2)

Dependents: 0
GitHub Stars: 0
Forks: 0
Contributors: 1

The npm package api-response-envelope receives a total of 2 downloads a week. As such, we scored api-response-envelope popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package api-response-envelope, we found that it has been starred ? times, and that 0 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.0.1

Indirect Vulnerabilities

1.0.1

License Risks

1.0.1

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like api-response-envelope is missing a security policy.

Snyk detected that the latest version of api-response-envelope has a security vulnerability.

We highly advise you to review these security issues.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like api-response-envelope is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test api-response-envelope

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 0
Merged PR: 0
Open PR: 0
Last Commit: 5 years ago

Further analysis of the maintenance status of api-response-envelope based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for api-response-envelope is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: No
Contributing.md: No
Code of Conduct: No
Contributors: 1
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like api-response-envelope is missing a Code of Conduct.

How about a good first contribution to this project? It seems that api-response-envelope is missing a README file.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 2 Direct / 24 Total
Versions: 3
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

We detected a total of 24 direct & transitive dependencies for api-response-envelope. See the full dependency tree of api-response-envelope

api-response-envelope has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

API Response Envelope

This is a node.js module that wraps output data in a standard envelope. It can handle 'success' and 'error' response wrapping, and will preserve formatting if null input values are used.

The format is as follows:

{
    "status": {success} | {error},
    "result": {array},
    "message": {string}
}

Requirements

No dependencies required for regular use.

Mocha and chai are required for running tests.

Installation and Usage

Usage:

var apiResponseEnvelope = require('api-response-envelope');

var myData = ['Nirvana', 'Soundgarden'];

var responseEnvelope = apiResponseEnvelope(myData);

...

Running Tests

Make sure that you have mocha and chai installed:

npm install

Now run the tests:

make test

Contributions

Contributions and feedback are welcome! Please open an issue or send a pull request.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.