LibTmux.ConvertTo-TmuxQueryJson
LibTmux\ConvertTo-TmuxQueryJson Serialize a native query document.
Source and package
- Declared in
- LibTmux
- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/ConvertToTmuxQueryJsonCommand.cs
- ConvertTo-TmuxQueryJson [-Query] <Lib
Tmux > [<Common.Query .Query Document Parameters >] -
Description#
Serializea native query document throughLibTmux.Query.Json. The returned string uses the shared schema 2 contract. Serialization performs no tmux I/O. Restore the document withNew-TmuxQuery-Json.Notes
Tmux.QueryJsonFailedterminates invalid serialization.Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
-
LibTmux.Query.QueryDocument: Native query documents. - Outputs
-
System.String
Examples#
Example 1
Serializea pane-width filter for storage or another native consumer. View sourceTerminal window LibTmux\New-TmuxQuery -Target Pane -Criteria @{ Width = @{ Ge = 80 } } |LibTmux\ConvertTo-TmuxQueryJson- Parameters
-
-
-Query(LibTmux ) #.Query .Query Document The native document to serialize.
- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
Common parameters 12
PowerShell supplies these parameters. See common parameter behavior for their effects.
-
-Verbose(System.Management ) #.Automation .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
System.String:OneJSON string per document.
Discussed in Filter and query tmux objects