Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davealdon/output-capture
👮 Captures the output of common ObjectScript terminal verbs, such as zwrite
https://github.com/davealdon/output-capture
intersystems intersystems-cache intersystems-iris intersystems-samples objectscript terminal
Last synced: 11 days ago
JSON representation
👮 Captures the output of common ObjectScript terminal verbs, such as zwrite
- Host: GitHub
- URL: https://github.com/davealdon/output-capture
- Owner: DaveAldon
- License: mit
- Created: 2019-09-19T20:12:23.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T14:43:25.000Z (2 months ago)
- Last Synced: 2024-10-12T13:09:50.045Z (25 days ago)
- Topics: intersystems, intersystems-cache, intersystems-iris, intersystems-samples, objectscript, terminal
- Language: ObjectScript
- Homepage:
- Size: 9.77 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Output-Capture
[](https://openexchange.intersystems.com/package/Output-Capture)
Captures the output of common objectscript terminal verbs, such as zwrite
Have you ever found great value in what zwrite, zzdump etc. outputs to the terminal? Did you ever want to store that information in a variable or something useful? Now you can!
## Usage
This function has **two** parameters: the variable, and the verb. The variable can be whatever you want to inspect, and the verb can be any of the following that normally output to the terminal:
- zwrite
- zzwrite
- zzdump
- write
The verb parameter is optional, and defaults to zwrite, but add any of these as a string to the second parameter of the function call to receive its output, like the following:
```
USER>set YOUR_VARIABLE = {"some":"thing"}
USER>write ##class(OutputCapture.capture).Get(YOUR_VARIABLE,"zzdump")
USER>41@%Library.DynamicArray
```
### If you don't want an array returned...
Just call the following for a string output:
```
USER>set x = {"asdasd":"asdasdasdasdasd"}
USER>write ##class(CaptureOutput.capture).GetString(x,"zwrite")
USER>var=[41@%Library.DynamicObject]
+----------------- general information ---------------
| oref value: 41
| class name: %Library.DynamicObject
| reference count: 4
+----------------- attribute values ------------------
| (none)
+-----------------------------------------------------
{65275,59764{9{
```
## Example
If you'd like to this is in action immediately, just call the "Example" function:
```
USER>write ##class(OutputCapture.capture).Example()
USER>0000: 33 37 40 25 4C 69 62 72 61 72 79 2E 44 79 6E 61 37@%Library.Dyna
0010: 6D 69 63 4F 62 6A 65 63 74 micObject{65275,58264{4{
```
This function sends a simple variable with the zzdump command, and loops through the returned object and outputs it so that you can see what everything looks like.
## Version history
2019-09-19 - v1.0 - Initial commit of functions with features outlined in description