Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • G gulp
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 24
    • Issues 24
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 3
    • Merge requests 3
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • gulp
  • gulp
  • Issues
  • #962
Closed
Open
Issue created Mar 16, 2015 by Administrator@rootContributor

Document plugin API

Created by: nalbion

The writing a plugin docs are very vague. Could you please document the parameters and returns?

/**
 * Assumptions, strategy etc...
 * @param {*} paramsFromGulp (optional) any parameters or config that may be passed from a Gulp script to the plugin
 * @return {no idea} Promise? Vinly? Stream? ????
 */
module.exports = function(paramsFromGulp) {

    /**
     * Assumptions, strategy etc...
     * @param {Vinyl} file - but pretend I have little/no experience with Vinyl or Node
     * @param {string} enc - presumably "utf8" etc
     * @param {function(Error?, Vinyl);WhatDoesItReturn?}
     * @return Promise? Vinly? Stream? ????   Because a callback is passed in, do we need to return anything?
     */
    return through.obj(function(file, enc, cb) {
    }
};
Assignee
Assign to
Time tracking