docs/02-reference.markdown @ bd7953d25dbd

Add basic wrapper functionality

Need to clean up the API for this at some point.
author Steve Losh <steve@stevelosh.com>
date Tue, 25 Aug 2020 00:08:28 -0400
parents a2712b3d3b16
children 6d74e7ab0fc0
# API Reference

The following is a list of all user-facing parts of Jarl.

If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.

Anything not listed here is subject to change at any time with no warning, so
don't touch it.

[TOC]

## Package `JARL`

### `PRINT-JSON` (function)

    (PRINT-JSON OBJECT &OPTIONAL (STREAM *STANDARD-OUTPUT*))

### `READ-JSON` (function)

    (READ-JSON &OPTIONAL (STREAM-OR-STRING *STANDARD-INPUT*) (EOF-ERROR-P T) EOF-VALUE)