Wondering what’s next for npm?Check out our public roadmap! »

    gulp-gzip
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/gulp-gzip package

    1.4.2 • Public • Published

    gulp-gzip

    Gzip plugin for gulp.

    # Install

    npm install --save-dev gulp-gzip
    

    Options

    append Boolean

    Appends .gz file extension if true. Defaults to true.

     gzip({ append: true })

    filename.txt becomes filename.txt.gz.

    extension String

    Appends an arbitrary extension to the filename. Disables append and preExtension options.

     gzip({ extension: 'zip' }) // note that the `.` should not be included in the extension

    filename.txt becomes filename.txt.zip.

    preExtension String

    Appends an arbitrary pre-extension to the filename. Disables append and extension options.

     gzip({ preExtension: 'gz' }) // note that the `.` should not be included in the extension

    filename.txt becomes filename.gz.txt.

    threshold String|Number|Boolean

    Minimum size required to compress a file. Defaults to false.

    gzip({ threshold: '1kb' })
    gzip({ threshold: 1024 })
    gzip({ threshold: true })

    gzipOptions Object

    Options object to pass through to zlib.Gzip. See zlib documentation for more information.

    gzip({ gzipOptions: { level: 9 } })
    gzip({ gzipOptions: { memLevel: 1 } })

    deleteMode String|Function

    Some webserver modules such as nginx gzip_static looks for example.html.gz, serve it if it exists, else the original example.html will be served.

    For instance, if example.html was 2kb, it would be gzipped and example.html.gz was created.

    However, if later example.html is modified to content less than the threshold, gulp-gzip will only bypass it. Hence, you will end up with a new example.html yet old example.html.gz. Your webserver will continue to serve old content (example.html.gz).

    Using this option, gulp-gzip will remove example.html.gz.

    It takes in the same argument as gulp.dest as in gulp.dest('mydest'), so it knows where to look for the gzipped files. Defaults to undefined.

    gzip({ threshold: 1024, deleteMode: 'mydest' })

    If you have cwd as in gulp.dest('mydest', { cwd: mycwd }). You can configure it using deleteModeCwd.

    gzip({ threshold: 1024, deleteMode: 'mydest', deleteModeCwd: mycwd })

    skipGrowingFiles Boolean

    Some files actually get larger after compression. If true, this option passes along the original, uncompressed file if compression increases the file size. Defaults to false.

     gzip({ skipGrowingFiles : true })

    Examples

    var gulp = require('gulp');
    var gzip = require('gulp-gzip');
     
    gulp.task('compress', function() {
        gulp.src('./dev/scripts/*.js')
        .pipe(gzip())
        .pipe(gulp.dest('./public/scripts'));
    });
    var gulp = require('gulp');
    var coffee = require('gulp-coffee');
    var concat = require('gulp-concat');
    var uglify = require('gulp-uglify');
    var gzip = require('gulp-gzip');
     
    gulp.task('deployScripts', function() {
        gulp.src('./dev/scripts/*.coffee')
        .pipe(coffee())
        .pipe(concat('all.js'))
        .pipe(uglify())
        .pipe(gzip())
        .pipe(gulp.dest('./public/scripts'));
    });
    var gulp = require('gulp');
    var tar = require('gulp-tar');
    var gzip = require('gulp-gzip');
     
    gulp.task('tarball', function() {
        gulp.src('./files/*')
        .pipe(tar('archive.tar'))
        .pipe(gzip())
        .pipe(gulp.dest('.'));
    });

    More examples.

    Install

    npm i gulp-gzip

    DownloadsWeekly Downloads

    26,972

    Version

    1.4.2

    License

    MIT

    Last publish

    Collaborators

    • avatar