Object/Measure-Word.ps1
|
function Measure-Word { <# .Synopsis Measures the count of words across all of the input objects. .Description Measures the count of words across all of the input objects--or one or more properties thereof--that are non-null. Null objects and properties are ignored. If there are zero non-null input objects, then zero is returned. Intended for convenience aliasing in interactive sessions. .Parameter Property Specifies one or more textual properties to measure. If no properties are specified, then either the object itself (if it is textual) or the string representation of the object (if it is non-textual), is measured. .Parameter IgnoreWhiteSpace Indicates that the cmdlet ignores white space. By default, white space is not ignored. .Inputs System.Management.Automation.PSObject You can pipe objects to `Measure-Word`. .Outputs System.Int32, Microsoft.PowerShell.Commands.TextMeasureInfo If more than one property is specified, then the command returns a TextMeasureInfo object for each property. Otherwise, it returns an int. If there are zero non-null input objects, then nothing is returned. .Notes The InputObject parameter should not be invoked directly. Rather, input should piped to this command. This command is a wrapper function of `Measure-Object`. .Link Measure-Object #> [CmdletBinding(RemotingCapability='None')] [OutputType([System.Int32], [Microsoft.PowerShell.Commands.TextMeasureInfo])] param( [Parameter(ValueFromPipeline=$true)] [PSObject] $InputObject, [Parameter(Position=0)] [ValidateNotNullOrEmpty()] [PSPropertyExpression[]] $Property, [Parameter()] [switch] $IgnoreWhiteSpace ) end { try { $arguments = @{ } foreach ($parameterName in @('Property', 'IgnoreWhiteSpace')) { if ($PSBoundParameters.ContainsKey($parameterName)) { $arguments[$parameterName] = $PSBoundParameters[$parameterName] } } $textMeasureInfo = $Input | Measure-Object -Character @arguments if ($null -ne $textMeasureInfo) { if ($Property.Count -gt 1) { $textMeasureInfo } else { $textMeasureInfo.Words } } } catch { throw } } } Set-Alias -Name 'words' -Value 'Measure-Word' -ErrorAction SilentlyContinue |