github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4719 from trusktr/npm-depends-docs

Browse Source 
Improve docs for Npm.depends.
This commit is contained in:
Sashko Stubailo
2015-07-12 16:06:05 -07:00
parent 519e666fcd a1738b37f7
commit 68322dab30
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
tools/package-source.js
View File

@@ -743,11 +743,15 @@ _.extend(PackageSource.prototype, {
* @summary Specify which [NPM](https://www.npmjs.org/) packages
* your Meteor package depends on.
* @param {Object} dependencies An object where the keys are package
* names and the values are version numbers in string form.
* You can only depend on exact versions of NPM packages. Example:
* names and the values are version numbers in string form or URLs to a
* git commit by SHA. You can only depend on exact versions of NPM
* packages. Example:
*
* ```js
* Npm.depends({moment: "2.8.3"});
* Npm.depends({
* moment: "2.8.3",
* async: "https://github.com/caolan/async/archive/71fa2638973dafd8761fa5457c472a312cc820fe.tar.gz"
* });
* ```
* @locus package.js
* @memberOf Npm