grunt-fastly
A Grunt plugin to purge cache from Fastly
Getting Started
This plugin requires Grunt ^1.0.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-fastly --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "fastly" task
Overview
In your project's Gruntfile, add a section named fastly
to the data object passed into grunt.initConfig()
.
grunt
Options
options.key
Type: String
Your API key from Fastly.
options.host
Type: String
The host you wish to purge from when purging individual files.
options.purgeAll
Type: Boolean
Default value: false
Purge all cached files from a cache. If this value is true, a serice id must also be provided.
options.purgeKey
Type: String
The key you wish to purge from a cache.
options.serviceId
Type: String
The service you wish to purge all the files from. Only required when option purgeAll
is true
or purging surrogate keys.
options.concurrentPurges
Type: Number
Default value: 10
The number of concurrent purges allowed at any one time.
Usage Examples
Purge All
In this example, all cached files will be purged from the production service.
grunt
Purge Key
In this example, all cached files associated with the key will be purged from the production service.
grunt
Purge selected files
In this example, we'll purge only selected files from the example.com host.
grunt
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.