Add additional doc pages

- Renamed existing doc pages to match module name
- Added new doc pages based on comments in undocumented modules

36 files changed, 356 insertions, 68 deletions

diff --git a/doc/api/argparse.mdz b/doc/api/argparse.mdz
index 87c6a0c..5a51dec 100644
--- a/doc/api/argparse.mdz
+++ b/doc/api/argparse.mdz
@@ -1,8 +1,7 @@
 {:title "argparse"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 0}
+ :template "mdzdoc/main.html"}
 ---
 
 A moderately opinionated argument parser for
diff --git a/doc/api/base64.mdz b/doc/api/base64.mdz
index ae0b8ee..9412551 100644
--- a/doc/api/base64.mdz
+++ b/doc/api/base64.mdz
@@ -1,8 +1,7 @@
 {:title "Base64"
  :author "Josef Pospíšil"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 99}
+ :template "mdzdoc/main.html"}
 ---
 
 # Base64
diff --git a/doc/api/build-rules.mdz b/doc/api/build-rules.mdz
new file mode 100644
index 0000000..1dbb9ba
--- /dev/null
+++ b/doc/api/build-rules.mdz
@@ -0,0 +1,10 @@
+{:title "Build Rules"
+ :template "mdzdoc/main.html"}
+---
+
+Run commands that produce files in an incremental manner.
+Use to implement a build system.
+
+## Reference
+
+@api-docs[../../spork/build-rules]
diff --git a/doc/api/cc.mdz b/doc/api/cc.mdz
new file mode 100644
index 0000000..da78671
--- /dev/null
+++ b/doc/api/cc.mdz
@@ -0,0 +1,28 @@
+{:title "CC"
+ :template "mdzdoc/main.html"}
+ ---
+
+Improved version of the C Compiler abstraction from JPM that should be more correct, composable, and
+have less configuration.
+
+Wrapper around the system C compiler for compiling Janet native modules and executables.
+Opinionated and optimized for use with Janet, and does not actually run
+commands unless specified with (dyn *visit*). Also included is package config integration.
+Headers, static libraries, and dynamic libraries can all be used from `(dyn *syspath*)`.
+
+## Example usage
+
+@codeblock[janet]```
+(use spork/cc)
+
+(search-static-libraries "m" "rt" "dl")
+(search-dynamic-libraries "janet")
+(pkg-config "sdl2" "vulkan")
+(with-dyns [*defines* {"GAME_BUILD" "devel-0.0"}
+            *visit* visit-execute-if-stale]
+  (compile-and-link-executable "game" "main.c" "sound.c" "graphics.c"))
+```
+
+## Reference
+
+@api-docs[../../spork/cc]
diff --git a/doc/api/channel.mdz b/doc/api/channel.mdz
new file mode 100644
index 0000000..69bb229
--- /dev/null
+++ b/doc/api/channel.mdz
@@ -0,0 +1,7 @@
+{:title "Channel Utilities"
+ :template "mdzdoc/main.html"}
+ ---
+
+## Reference
+
+@api-docs[../../spork/channel]
diff --git a/doc/api/cjanet.mdz b/doc/api/cjanet.mdz
new file mode 100644
index 0000000..6203399
--- /dev/null
+++ b/doc/api/cjanet.mdz
@@ -0,0 +1,16 @@
+{:title "CJanet"
+ :template "mdzdoc/main.html"}
+ ---
+
+A DSL that compiles to C. Improved version of jpm/cgen
+that is more amenable to Janet integration, macros,
+and meta-programming.
+
+The semantics of the language are basically the
+same as C so a higher level language (or type system)
+should be built on top of this. This IR emits a very useful
+subset of valid C 99.
+
+## Reference
+
+@api-docs[../../spork/cjanet]
diff --git a/doc/api/crc.mdz b/doc/api/crc.mdz
new file mode 100644
index 0000000..4934b12
--- /dev/null
+++ b/doc/api/crc.mdz
@@ -0,0 +1,7 @@
+{:title "CRC"
+ :template "mdzdoc/main.html"}
+ ---
+
+ Generate CRC variants. Rather than compile separate variants, we have code to generate the needed tables. 
+Keeps build simple, footprint small but with many variants accessible.
+
diff --git a/doc/api/cron.mdz b/doc/api/cron.mdz
new file mode 100644
index 0000000..885c78f
--- /dev/null
+++ b/doc/api/cron.mdz
@@ -0,0 +1,36 @@
+{:title "Cron"
+ :template "mdzdoc/main.html"}
+ ---
+
+Timer library for interfacing with the UNIX crontab format.
+
+The cron format support is based on the unix cron syntax, with an optional
+seconds field. Each field can be a comma separated list of individual values
+or a range of values.
+A range has three variants as follows
+  Two values with a "-" between them, optionally followed by a "/" and a step value.
+  An asterisk ("*") followed by a "/" and a step value. This implies every "step" value.
+  A single value followed by a "/" and a step value. This implies every "step" value
+    starting with the single value. i.e. 2/3 implies every 3 units from 2 to max units.
+A single asterisk ("*") can be used to denote all possible values.
+
+The fields:
+ * minutes: 0-59
+ * hours: 0-23
+ * day of month: 1-31
+ * month: 1-12. Also allowed are the following month codes in any case:
+   jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec
+ * day of week: 0-7, where 0 or 7 is sunday, monday is 1, etc. allows the following day codes (any case):
+   sun,mon,tue,wed,thu,fri,sat
+ * seconds (optional): 0-59
+
+Cron schedules are represented as tuples of 7 values, a string representation, followed
+by 6 bitmaps representing matching timestamps. Bitmaps are represented as any byte sequence.
+
+[string-rep minutes hours day-of-month month day-of-week seconds]
+
+Note that we have second precision here as opposed to minute precision
+
+## Reference
+
+@api-docs[../../spork/cron]
diff --git a/doc/api/data.mdz b/doc/api/data.mdz
index 13f9bde..b36472e 100644
--- a/doc/api/data.mdz
+++ b/doc/api/data.mdz
@@ -1,8 +1,7 @@
 {:title "data"
  :author "Caleb Figgers"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 1}
+ :template "mdzdoc/main.html"}
 ---
 
 @p{@link[https://clojure.org/]{Clojure} contains a very useful core library (or "namespace" in Clojure parlance) called @link[https://clojure.github.io/clojure/clojure.data-api.html]{clojure.data} (@link[https://github.com/clojure/clojure/blob/51c6d7a70912a8f65e81a8e11ae6f56c94920725/src/clj/clojure/data.clj]{source}). It contains one "exported" function: @code`clojure.data/diff`. This addition to spork, @code`data.janet`, should exactly replicate the behavior of @code`clojure.data/diff` using Janet tables, structs, arrays, and tuples in place of their Clojure equivalents.}
diff --git a/doc/api/ev-utils.mdz b/doc/api/ev-utils.mdz
new file mode 100644
index 0000000..5380f9b
--- /dev/null
+++ b/doc/api/ev-utils.mdz
@@ -0,0 +1,9 @@
+{:title "Event Loop Utilities"
+ :template "mdzdoc/main.html"}
+ ---
+
+Module for parallel execution utilities with Janet.
+
+## Reference
+
+@api-docs[../../spork/ev-utils]
diff --git a/doc/api/formatting.mdz b/doc/api/fmt.mdz
index bd6821e..c146830 100644
--- a/doc/api/formatting.mdz
+++ b/doc/api/fmt.mdz
@@ -1,8 +1,7 @@
 {:title "Formatting"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 2}
+ :template "mdzdoc/main.html"}
 ---
 
 Provides a way to format Janet code strings and files.
diff --git a/doc/api/generators.mdz b/doc/api/generators.mdz
index 30b2d67..736abad 100644
--- a/doc/api/generators.mdz
+++ b/doc/api/generators.mdz
@@ -1,8 +1,7 @@
 {:title "Generators"
  :author "Z. D. Smith"
  :license "BSD3"
- :template "mdzdoc/main.html"
- :order 3}
+ :template "mdzdoc/main.html"}
 ---
 
 # Generators for Janet
diff --git a/doc/api/getline.mdz b/doc/api/getline.mdz
new file mode 100644
index 0000000..49f4fab
--- /dev/null
+++ b/doc/api/getline.mdz
@@ -0,0 +1,9 @@
+{:title "Getline"
+ :template "mdzdoc/main.html"}
+ ---
+
+Module for fiber-based sequence combinators rather than array-based combinators, as are in the core library.
+
+## Reference
+
+@api-docs[../../spork/getline]
diff --git a/doc/api/htmlgen.mdz b/doc/api/htmlgen.mdz
index 896ebe6..bbe8e0a 100644
--- a/doc/api/htmlgen.mdz
+++ b/doc/api/htmlgen.mdz
@@ -1,8 +1,7 @@
 {:title "HTMLgen"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 4}
+ :template "mdzdoc/main.html"}
 ---
 
 HTMLgen is a rendering engine that can render plain data structures into
diff --git a/doc/api/http.mdz b/doc/api/http.mdz
index 2808fc2..0533602 100644
--- a/doc/api/http.mdz
+++ b/doc/api/http.mdz
@@ -1,8 +1,7 @@
 {:title "HTTP"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 5}
+ :template "mdzdoc/main.html"}
 ---
 
 The @code`http` module is an HTTP/1.1 parser, server and client module. It proves a simple server implementation, client, support for chunked encoding.
diff --git a/doc/api/httpf.mdz b/doc/api/httpf.mdz
new file mode 100644
index 0000000..9354bc7
--- /dev/null
+++ b/doc/api/httpf.mdz
@@ -0,0 +1,11 @@
+{:title "HTTPF"
+ :template "mdzdoc/main.html"}
+ ---
+
+A simple, opinionated HTTP framework for HTML, JDN, and JSON servers.
+Servers can easily be configured from defn bindings with
+appropriate metadata.
+
+## Reference
+
+@api-docs[../../spork/httpf]
diff --git a/doc/api/infix.mdz b/doc/api/infix.mdz
new file mode 100644
index 0000000..7bf1c2a
--- /dev/null
+++ b/doc/api/infix.mdz
@@ -0,0 +1,38 @@
+{:title "Infix"
+ :template "mdzdoc/main.html"}
+ ---
+
+# Infix
+A macro for infix syntax in Janet. Useful for math.
+
+## Examples
+
+@codeblock[janet]```
+    ($$ a + b ** 2)            --->   (+ a (math/pow b 2))
+    ($$ (a + b) ** 2)          --->   (math/pow (+ a b) 2)
+    ($$ y[2] + y[3])           --->   (+ (in y 2) (in y 3))
+    ($$ a > b and ,(good? z))  --->   (and (> a b) (good? z))
+```
+
+## Syntax
+
+Syntax is as follows:
+
+  Binary operators <<, >>, >>>, =, !=, <, <=, >, >=, &, ^, bor, band, and, or,
+  +, -, *, /, %, ** are supported. Operator precedence is in the
+  `precedence table below (higher means more tightly binding). All
+  operators are left associative except ** (math/pow), which is right
+  associative.
+
+  Unary prefix operators !, -, bnot, not, ++, -- are supported.
+  No unary postfix operators are supported.
+
+  Square brackets can be used for indexing.
+
+  Normal parentheses are used for making subgroups
+
+  You can "escape" infix syntax use a quote or unquote (comma)
+
+## Reference
+
+@api-docs[../../spork/infix]
diff --git a/doc/api/math.mdz b/doc/api/math.mdz
index 5bd09a1..4103ede 100644
--- a/doc/api/math.mdz
+++ b/doc/api/math.mdz
@@ -1,8 +1,7 @@
 {:title "Math"
  :author "Josef Pospíšil"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 7}
+ :template "mdzdoc/main.html"}
 ---
 
 The math module deals with two main areas of mathematics: statistics 
diff --git a/doc/api/mdz.mdz b/doc/api/mdz.mdz
new file mode 100644
index 0000000..8054b2b
--- /dev/null
+++ b/doc/api/mdz.mdz
@@ -0,0 +1,9 @@
+{:title "Mendoza"
+ :template "mdzdoc/main.html"}
+ ---
+
+Re-implementation of mendoza markup. Designed to work with htmlgen.
+
+## Reference
+
+@api-docs[../../spork/mdz]
diff --git a/doc/api/misc.mdz b/doc/api/misc.mdz
index f6b33be..9d90ca3 100644
--- a/doc/api/misc.mdz
+++ b/doc/api/misc.mdz
@@ -1,8 +1,7 @@
 {:title "Misc"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 9}
+ :template "mdzdoc/main.html"}
 ---
 
 ## Dedent
diff --git a/doc/api/message-protocol.mdz b/doc/api/msg.mdz
index 3e87b63..13b1c07 100644
--- a/doc/api/message-protocol.mdz
+++ b/doc/api/msg.mdz
@@ -1,8 +1,7 @@
 {:title "Message Protocol"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 8}
+ :template "mdzdoc/main.html"}
 ---
 
 Provide a symmetric way to send and receive seqential messages over a
diff --git a/doc/api/netrepl.mdz b/doc/api/netrepl.mdz
new file mode 100644
index 0000000..2603e97
--- /dev/null
+++ b/doc/api/netrepl.mdz
@@ -0,0 +1,75 @@
+{:title "Netrepl"
+ :template "mdzdoc/main.html"}
+ ---
+
+# Networked REPL
+
+A simple async networked repl (both client and server) with a remote debugger
+and the ability to repl into existing environments.
+
+
+## Specifying the Environment
+
+Provide various ways to produce the environment to repl into.
+1. an environment factory function, called for each connection.
+2. an env (table value) - this means every connection will share the same environment
+3. default env, made via make-env with nice printing for each new connection.
+
+
+## NETREPL Protocol
+
+Clients don't need to support steps 4. and 5. if they never send messages prefixed with 0xFF or 0xFE bytes. These bytes should not occur in normal Janet source code and are not even valid utf8.
+
+Any message received by the client that begins with 0xFF should result in printing the message to a console, but not otherwise interrupt the flow of the protocol. 
+  This easily allows for partial results. A server should not send messages leading with 0xFF to the client unless the client is created with the :auto-flush connection setting.
+
+Any message received by the client that begins with 0xFE will discard this first byte and continue processing as usual.
+
+1. server <- {connection settings, including client name} <- client
+  1a. If msg starts with 0xFF, parse message as (-> msg (slice 1) parse) and extract
+      the :name key as the name. Other connection settings can be stored here.
+  1b. If msg does not start with 0xFF, the message is treated as the client name.
+      Other options are considered nil.
+2. server -> {repl prompt (no newline)} -> client
+3. server <- {one chunk of input (msg)} <- client
+4. If (= (msg 0) 0xFF)
+  4a. (def result (-> msg (slice 1) parse eval protect))
+  4b. server -> result -> client
+  4c. goto 3.
+5. If (= (msg 0) 0xFE)
+  5a. Return msg as either:
+      i. a keyword if the msg contains a command (e.g. :cancel)
+      ii. an array if the msg contains a command and arguments (e.g. @code`@[:source "path/to/source"]`
+  5b. goto 6b.
+6. Otherwise
+  6a. Send chunk to repl input stream
+  6b. Unless auto-flush is enabled, server -> {(dyn :out) and (dyn :err) (empty at first)} -> client
+  6c. goto 2.
+
+## Examples
+
+Launch a networked REPL server on one machine and connect to it from another machine or process.
+
+### Server
+
+@codeblock[janet]```
+(import spork/netrepl)
+
+(def some-def 10)
+
+# Serve a repl into the current environment (@code`some-def` will be visible).
+(netrepl/server "127.0.0.1" "9000" (fiber/getenv (fiber/current)))
+```
+
+### Client
+
+@codeblock[janet]```
+(import spork/netrepl)
+
+# Starts a nice terminal repl.
+(netrepl/client "127.0.0.1" "9000" "bob")
+```
+
+## Reference
+
+@api-docs[../../spork/netrepl]
diff --git a/doc/api/networked-repl.mdz b/doc/api/networked-repl.mdz
deleted file mode 100644
index 0305353..0000000
--- a/doc/api/networked-repl.mdz
+++ /dev/null
@@ -1,34 +0,0 @@
-{:title "Networked REPL"
- :author "Calvin Rose"
- :license "MIT"
- :template "mdzdoc/main.html"
- :order 10}
----
-
-Launch a networked REPL server on one machine and connect to it from
-another machine or process.
-
-## Server
-
-@codeblock[janet]```
-(import spork/netrepl)
-
-(def some-def 10)
-
-# Serve a repl into the current environment (@code`some-def` will be visible).
-(netrepl/server "127.0.0.1" "9000" (fiber/getenv (fiber/current)))
-```
-
-## Client
-
-@codeblock[janet]```
-(import spork/netrepl)
-
-# Starts a nice terminal repl.
-(netrepl/client "127.0.0.1" "9000" "bob")
-```
-
-## Reference
-
-@api-docs[../../spork/netrepl]
-
diff --git a/doc/api/path.mdz b/doc/api/path.mdz
index 4284502..26cb2aa 100644
--- a/doc/api/path.mdz
+++ b/doc/api/path.mdz
@@ -1,8 +1,7 @@
 {:title "Path"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 11}
+ :template "mdzdoc/main.html"}
 ---
 Simple path manipulation module for Janet. Supports manipulation both
 windows and posix paths on any platform, and provides functions that
diff --git a/doc/api/pgp.mdz b/doc/api/pgp.mdz
index d448b96..54a38ee 100644
--- a/doc/api/pgp.mdz
+++ b/doc/api/pgp.mdz
@@ -1,8 +1,7 @@
 {:title "PGP"
  :author "Josef Pospíšil"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 99}
+ :template "mdzdoc/main.html"}
 ---
 
 # PGP
diff --git a/doc/api/randgen.mdz b/doc/api/randgen.mdz
index 429d113..53d762d 100644
--- a/doc/api/randgen.mdz
+++ b/doc/api/randgen.mdz
@@ -1,8 +1,7 @@
 {:title "Random Generator"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 12}
+ :template "mdzdoc/main.html"}
 ---
 
 A small utility for random number generation, especially with a focus on
diff --git a/doc/api/regex.mdz b/doc/api/regex.mdz
index f21cacd..4eafec7 100644
--- a/doc/api/regex.mdz
+++ b/doc/api/regex.mdz
@@ -1,8 +1,7 @@
 {:title "Regex"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 13}
+ :template "mdzdoc/main.html"}
 ---
 
 A module for compiling a subset of regexes to Janet PEGs.
diff --git a/doc/api/rpc-protocol.mdz b/doc/api/rpc.mdz
index ad413a2..cadd791 100644
--- a/doc/api/rpc-protocol.mdz
+++ b/doc/api/rpc.mdz
@@ -1,8 +1,7 @@
 {:title "RPC Protocol"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 14}
+ :template "mdzdoc/main.html"}
 ---
 
 A simple remote procedure call tool for Janet.
diff --git a/doc/api/schema.mdz b/doc/api/schema.mdz
new file mode 100644
index 0000000..7f3e86a
--- /dev/null
+++ b/doc/api/schema.mdz
@@ -0,0 +1,40 @@
+{:title "Schema"
+ :template "mdzdoc/main.html"}
+ ---
+
+# Schema
+
+Simple schema validation library. Specify structure declaratively, and get
+functions that will check that structure and either raise an error or return a boolean.
+While reasonably general, use is intended for data such as one would find
+in configuration files or network protocols.
+
+Currently does not support more advanced features such as:
+  - Recursive schemas
+  - Full error reporting (only a single error is reported)
+  - PEG style grammars (used to enable recursion in PEGs)
+  - Unification (such as in the `match` macro)
+  - Parsing/data extraction
+
+Syntax:
+ - :keyword - match any value of that type
+ - Tuples are used to match various combinators:
+   - (any) - match any one value
+   - (enum & options) - match any of the option values
+   - (or & schemas) - similar to enum, but each option is considered a schema.
+   - (and & schemas) - Only matches if all clauses match
+   - (values schema) - Matches only if schema matches all values in a data structure.
+   - (keys schema) - Matches only if schema matches all keys in a data structure.
+   - (props & k v) - Takes a sequence of keys and values (alternating in order). Only matches
+     the data if, for a key, the corresponding schema `v` matches.
+   - (length l) - Only match if the data has a length of l. Uses of the length combinator should assert
+     the data type before doing a length check.
+   - (length min max) - Only match lengths between min and max inclusive
+   - (peg pattern) - Matches only if the peg matches
+   - (not pattern) - Only matches if pattern does not match
+   - (pred predicate) - Use a predicate function (function of 1 argument) to check if the data is valid.
+ - anything else - match that value literally
+
+## Reference
+
+@api-docs[../../spork/schema]
diff --git a/doc/api/services.mdz b/doc/api/services.mdz
new file mode 100644
index 0000000..116ff3b
--- /dev/null
+++ b/doc/api/services.mdz
@@ -0,0 +1,11 @@
+{:title "Services"
+ :template "mdzdoc/main.html"}
+ ---
+
+
+Module for running a number of background processes in a controlled manner.
+Similar to ev-utils, but more involved with defaults for IO and naming fibers for debugging purposes. Services can also implicitly launch sibling or child services if needed.
+
+## Reference
+
+@api-docs[../../spork/services]
diff --git a/doc/api/sh.mdz b/doc/api/sh.mdz
new file mode 100644
index 0000000..1595162
--- /dev/null
+++ b/doc/api/sh.mdz
@@ -0,0 +1,9 @@
+{:title "Shell Utilities"
+ :template "mdzdoc/main.html"}
+ ---
+
+Shell utilities for Janet.
+
+## Reference
+
+@api-docs[../../spork/sh]
diff --git a/doc/api/stream.mdz b/doc/api/stream.mdz
new file mode 100644
index 0000000..2e676f4
--- /dev/null
+++ b/doc/api/stream.mdz
@@ -0,0 +1,9 @@
+{:title "Stream"
+ :template "mdzdoc/main.html"}
+ ---
+
+Stream utilities for Janet.
+
+## Reference
+
+@api-docs[../../spork/stream]
diff --git a/doc/api/tasker.mdz b/doc/api/tasker.mdz
new file mode 100644
index 0000000..7a600ea
--- /dev/null
+++ b/doc/api/tasker.mdz
@@ -0,0 +1,9 @@
+{:title "Tasker"
+ :template "mdzdoc/main.html"}
+ ---
+
+A simple task executor library/server.
+
+## Reference
+
+@api-docs[../../spork/tasker]
diff --git a/doc/api/temple.mdz b/doc/api/temple.mdz
index 83ebfa4..dd6658e 100644
--- a/doc/api/temple.mdz
+++ b/doc/api/temple.mdz
@@ -1,8 +1,7 @@
 {:title "Temple"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 15}
+ :template "mdzdoc/main.html"}
 ---
 
 HTML templates for Janet.
diff --git a/doc/api/test.mdz b/doc/api/test.mdz
index 44f61b6..6e84b0d 100644
--- a/doc/api/test.mdz
+++ b/doc/api/test.mdz
@@ -1,8 +1,7 @@
 {:title "Test"
  :author "Calvin Rose"
  :license "MIT"
- :template "mdzdoc/main.html"
- :order 16}
+ :template "mdzdoc/main.html"}
 ---
 
 This module contains a simple test helper when you do not need a specialized
diff --git a/doc/api/zip.mdz b/doc/api/zip.mdz
new file mode 100644
index 0000000..9f645d4
--- /dev/null
+++ b/doc/api/zip.mdz
@@ -0,0 +1,6 @@
+{:title "Zip"
+ :template "mdzdoc/main.html"}
+ ---
+
+Wrapper around miniz for compression functionality.
+