Skip to content

Latest commit

 

History

History
121 lines (105 loc) · 4.65 KB

Dump.md

File metadata and controls

121 lines (105 loc) · 4.65 KB

Function: Dump

Outputs the contents of a variable (simple or complex) of any type for debugging purposes to a specific output location.

The available {@code output} locations are:

buffer : The output is written to the buffer, which is the default location. If running on a web server, the output is written to the browser. - console : The output is printed to the System console. - {absolute_file_path} The output is written to a file with the specified filename path.

The output {@code format} can be either HTML or plain text. The default format is HTML if the output location is the buffer or a web server or a file, otherwise it is plain text for the console.

Method Signature

Dump(var=[any], label=[string], top=[numeric], expand=[boolean], abort=[boolean], output=[string], format=[string], showUDFs=[boolean])

Arguments

Argument Type Required Description Default
var any false The variable to dump, can be any type
label string false A custom label to display above the dump (Only in HTML output)
top numeric false The number of levels to display when dumping collections. Great to avoid dumping the entire world! Default is inifinity. (Only in HTML output) 0
expand boolean false Whether to expand the dump. Be default, we try to expand as much as possible. (Only in HTML output)
abort boolean false Whether to do a hard abort the request after dumping. Default is false false
output string false The output format which can be "buffer", "console", or "{absolute file path}". The default is "buffer". buffer
format string false The format of the output to a filename. Can be "html" or "text". The default is according to the output location.
showUDFs boolean false Show UDFs or not. Default is true. (Only in HTML output) true

Examples

Related