forked from chocolatey/choco
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(chocolateyGH-697) Update Code With Documentation
Update all of the code with documentation based on what is needed and what is already available on the wiki. This will allow documentation to have one source of truth regarding Commands and PowerShell Helpers.
- Loading branch information
1 parent
2a9e0ba
commit 3ed1f37
Showing
57 changed files
with
2,695 additions
and
913 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 48 additions & 13 deletions
61
src/chocolatey.resources/helpers/functions/Format-FileSize.ps1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,60 @@ | ||
| # Copyright © 2011 - Present RealDimensions Software, LLC | ||
| # | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # | ||
| # | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| Function Format-FileSize() { | ||
| Param ([double]$size) | ||
| Foreach ($unit in @('B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB')) { | ||
| If ($size -lt 1024) { | ||
| return [string]::Format("{0:0.##} {1}", $size, $unit) | ||
| } | ||
| $size /= 1024 | ||
| Function Format-FileSize { | ||
| <# | ||
| .SYNOPSIS | ||
| DO NOT USE. Not part of the public API. | ||
| .DESCRIPTION | ||
| Formats file size into a human readable format. | ||
| .NOTES | ||
| Available in 0.9.10+. | ||
| This function is not part of the API. | ||
| .INPUTS | ||
| None | ||
| .OUTPUTS | ||
| Returns a string representation of the file size in a more friendly | ||
| format based on the passed in bytes. | ||
| .PARAMETER Size | ||
| The size of a file in bytes. | ||
| .PARAMETER IgnoredArguments | ||
| Allows splatting with arguments that do not apply. Do not use directly. | ||
| .EXAMPLE | ||
| Format-FileSize -Size $fileSizeBytes | ||
| .LINK | ||
| Get-WebFile | ||
| #> | ||
| param ( | ||
| [Parameter(Mandatory=$true)][double]$size | ||
| ) | ||
| Write-Debug "Running 'Format-FileSize' with size: '$size'"; | ||
|
|
||
| Foreach ($unit in @('B', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB')) { | ||
| If ($size -lt 1024) { | ||
| return [string]::Format("{0:0.##} {1}", $size, $unit) | ||
| } | ||
| return [string]::Format("{0:0.##} YB", $size) | ||
| } | ||
| $size /= 1024 | ||
| } | ||
|
|
||
| return [string]::Format("{0:0.##} YB", $size) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.