Package Exports
- gulp-notify
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-notify) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
gulp-notify 
notification plugin for gulp
Information
| Package | gulp-notify |
|---|---|
| Description | Send messages to Mac Notification center using the node-notifier module. Can also specify custom notifier (e.g. Growl notification). |
| Node Version | >= 0.8 |
Note: Without overriding the notifier, Mac OS X >= 10.8 is required for this to run.
Usage
First, install gulp-notify as a development dependency:
npm install --save-dev gulp-notifyThen, add it to your gulpfile.js:
var notify = require("gulp-notify");
gulp.src("./src/test.ext")
.pipe(notify({
message: "Hello Gulp!"
}));API
notify(String)
A message to notify per data on stream.
notify(Function)
Type: function(file)
The result of the function is used as message. File from gulp stream passed in as argument.
notify(options)
options.onLast
Type: Boolean
Default: false
If the notification should only happen on the last file of the stream. Per default a notification is triggered on each file.
options.message
Type: String
Default: File path in stream
The message you wish to attach to file.
options.title
Type: String
Default: "Gulp Notification"
The title of the notification
options.notifier
Type: Function(options, callback)
Default: node-notifier module
Swap out the notifier by passing in an function. The function expects two arguments: options and callback.
The callback must be called when the notification is finished. Options will contain both title and message.