Permalink
Fetching contributors…
Cannot retrieve contributors at this time
38 lines (22 sloc) 1018 Bytes

Handlers

Handlers are functions which load and transform files. Rosid doesn't care about how they transform them, but requires them to return a promise. The promise should resolve a string that contains the content of the transformed file.

Existing handlers

See all handlers »

Custom handler

Check out our "Writing a handler" guide to learn how to build your own handler.

Example:

/*
 * A handler that always returns 'Hello World!'.
 */
module.exports = function(filePath, opts) {

	return Promise.resolve('Hello World!')

}

Parameters:

  • filePath {String} Absolute path to file.
  • route {Object} Options from the route.

Returns:

  • {Promise<String|Buffer>} The transformed file content.

Distributing a handler

Handlers should be distributed through npm. The recommended prefix is rosid-handler- and the package.json of your handler should at least contain the tags rosid and handler.