npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@verdigris/adonis-compression

v1.0.0

Published

AdonisJs middleware provider that wraps compression module

Downloads

99

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

andrew-joandrew-joverdigris-serviceverdigris-service

Keywords

adonisjsadonisadonis-compressioncompressiongzipzlib

Readme

AdonisJs Compression 🗜

This repo contains a provider for a middleware that compresses HTTP responses with GZip.

NPM Version Build Coverage License

Intended use case — read me first

This middleware was originally created to compress verbose JSONAPI responses. If you are considering this middleware for compressing static assets in production, please consider using nginx or lighttpd instead. These servers are vastly superior to Node.js in performance for serving static assets.

Setup

Install the provider from npm:

adonis install @verdigris/adonis-compression

Next make sure to read the INSTRUCTIONS.md file.

Node/OS Target

This repo/branch is intended to run on all major OS platforms and targets Node.js >= 8.0

Development

Please read CONTRIBUTING.md to learn about the contribution guidelines before contributing to this codebase.

Run the following command to see list of available npm scripts:

npm run

Tests & linting

  1. Unlike majority of AdonisJs codebase, this repository follows official corporate Verdigris Technologies ECMAScript 6 styleguide. Run npm run lint command to check if there are any linting errors.
  2. Make sure you write tests for all changes/bug fixes.
  3. Also you can write regression tests, which shows that something is failing but doesn't breaks the build. Which is actually a nice way to show that something fails. Regression tests are written using test.failing() method.
  4. Make sure all tests are passing on CircleCI.

General practices

Most of the ES6 language features are officially supported on Node.js v8. Please make use of the ES6 language features. For example:

  1. Use Spread syntax over arguments keyword in functions.
  2. Never use bind or call. After calling these methods, AdonisJs cannot guarantee the scope of any methods.
  3. Make sure to write proper docblock.

License

This software is distributed AS IS WITHOUT WARRANTY under Simplified BSD license.

Verdigris Technologies Inc. assumes NO RESPONSIBILITY OR LIABILITY UNDER ANY CIRCUMSTANCES for usage of this software. See the LICENSE.md file for detailed legal information.

Copyright © 2019 Verdigris Technologies Inc. All rights reserved.