Spearhead/node-spearhead
Archived
3
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

fix parseVolumeSize comments doc according to latest changes

Browse Source
This commit is contained in:
Julien Gilli 2017-04-03 18:56:26 -07:00
parent c68c975d88
commit cb725eb587
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
lib/volumes.js
View File

@ -18,7 +18,16 @@ function throwInvalidSize(size) {
/* /*
* Returns the number of MiBs (Mebibytes) represented by the string "size". That * Returns the number of MiBs (Mebibytes) represented by the string "size". That
* string can have different format suffixes, such as "100GB", "100G", etc. * string has the following format: <integer><unit>. The integer must be > 0.
* Unit format suffixes are 'G' or 'g' for gibibytes and 'M' or 'm' for
* mebibytes. If no unit suffix is provided, the unit is considered to be
* mebibytes.
*
* Examples:
* - the string '100' represents 100 mebibytes
* - the strings '100g' and '100G' represent 100 gibibytes
* - the string '100' represents 100 mebibytes
*
* If "size" is not a valid size string, an error is thrown. * If "size" is not a valid size string, an error is thrown.
*/ */
function parseVolumeSize(size) { function parseVolumeSize(size) {