add pretty print to object mod

[briandowns]

Resolves: #682

What's Changed:

Added pretty print function into the Object module.

Type of Change:

• [ ] Bug fix
• [x] New feature
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

#

Housekeeping:

• [x] Tests have been updated to reflect the changes done within this PR (if applicable).
• [x] Documentation has been updated to reflect the changes done within this PR (if applicable).

#

Screenshots (If Applicable):

[Jason2605]

A question for you, would you expect a method called prettyPrint to actually output to stdout rather than return a string? I think a method that returns the pretty output as a string would be useful but potentially under a different name, what do you think?

[briandowns]

Yeah, that's a good point. I'll update this to print to stdout. What would you want the method name to be that would returned the "pretty" string?

[Jason2605]

Actually we probably don't need the non-print version as you can just use JSON.stringify - at least for the minute until we extend it so we can pretty print more objects that aren't JSON serialisable

[briandowns]

Good point.

[Jason2605]

Thanks so much for this!