@grain/stdlib 0.5.13 → 0.6.1

package/buffer.md

@@ -12,12 +12,26 @@ No other changes yet.
 </details>
 
 ```grain
-import Buffer from "buffer"
+from "buffer" include Buffer
+```
+
+```grain
+Buffer.make(64)
+```
+
+## Types
+
+Type declarations included in the Buffer module.
+
+### Buffer.**Buffer**
+
+```grain
+type Buffer
 ```
 
 ## Values
 
-Functions for working with the Buffer data type.
+Functions and constants included in the Buffer module.
 
 ### Buffer.**make**
 
@@ -27,7 +41,7 @@ No other changes yet.
 </details>
 
 ```grain
-make : Number -> Buffer
+make : (initialSize: Number) => Buffer
 ```
 
 Creates a fresh buffer, initially empty.
@@ -53,6 +67,16 @@ Throws:
 
 * When the `initialSize` is a negative number
 
+Examples:
+
+```grain
+Buffer.make(0)
+```
+
+```grain
+Buffer.make(64)
+```
+
 ### Buffer.**length**
 
 <details disabled>
@@ -61,7 +85,7 @@ No other changes yet.
 </details>
 
 ```grain
-length : Buffer -> Number
+length : (buffer: Buffer) => Number
 ```
 
 Gets the number of bytes currently contained in a buffer.
@@ -78,6 +102,18 @@ Returns:
 |----|-----------|
 |`Number`|The length of the buffer in bytes|
 
+Examples:
+
+```grain
+Buffer.length(Buffer.make(32)) == 0
+```
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addInt32(1l, buf)
+assert Buffer.length(buf) == 4
+```
+
 ### Buffer.**clear**
 
 <details disabled>
@@ -86,7 +122,7 @@ No other changes yet.
 </details>
 
 ```grain
-clear : Buffer -> Void
+clear : (buffer: Buffer) => Void
 ```
 
 Clears data in the buffer and sets its length to zero.
@@ -99,6 +135,16 @@ Parameters:
 |-----|----|-----------|
 |`buffer`|`Buffer`|The buffer to clear|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addInt32(1l, buf)
+assert Buffer.length(buf) == 4
+Buffer.clear(buf)
+assert Buffer.length(buf) == 0
+```
+
 ### Buffer.**reset**
 
 <details disabled>
@@ -107,7 +153,7 @@ No other changes yet.
 </details>
 
 ```grain
-reset : Buffer -> Void
+reset : (buffer: Buffer) => Void
 ```
 
 Empty a buffer and deallocate the internal byte sequence holding the buffer contents.
@@ -120,6 +166,16 @@ Parameters:
 |-----|----|-----------|
 |`buffer`|`Buffer`|The buffer to reset|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addInt32(1l, buf)
+assert Buffer.length(buf) == 4
+Buffer.reset(buf)
+assert Buffer.length(buf) == 0
+```
+
 ### Buffer.**truncate**
 
 <details disabled>
@@ -128,7 +184,7 @@ No other changes yet.
 </details>
 
 ```grain
-truncate : (Number, Buffer) -> Void
+truncate : (length: Number, buffer: Buffer) => Void
 ```
 
 Shortens a buffer to the given length.
@@ -149,6 +205,16 @@ Throws:
 * When the `length` is negative
 * When the `length` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addInt32(1l, buf)
+assert Buffer.length(buf) == 4
+Buffer.truncate(1, buf)
+assert Buffer.length(buf) == 1
+```
+
 ### Buffer.**toBytes**
 
 <details disabled>
@@ -157,7 +223,7 @@ No other changes yet.
 </details>
 
 ```grain
-toBytes : Buffer -> Bytes
+toBytes : (buffer: Buffer) => Bytes
 ```
 
 Returns a copy of the current contents of the buffer as a byte sequence.
@@ -174,6 +240,14 @@ Returns:
 |----|-----------|
 |`Bytes`|A byte sequence made from copied buffer data|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addString("test", buf)
+assert Buffer.toBytes(buf) == b"test"
+```
+
 ### Buffer.**toBytesSlice**
 
 <details disabled>
@@ -182,7 +256,7 @@ No other changes yet.
 </details>
 
 ```grain
-toBytesSlice : (Number, Number, Buffer) -> Bytes
+toBytesSlice : (start: Number, length: Number, buffer: Buffer) => Bytes
 ```
 
 Returns a slice of the current contents of the buffer as a byte sequence.
@@ -209,6 +283,14 @@ Throws:
 * When `start` is greater than or equal to the buffer size
 * When `start + length` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addString("HelloWorld", buf)
+assert Buffer.toBytesSlice(0, 5, buf) == b"Hello"
+```
+
 ### Buffer.**toString**
 
 <details disabled>
@@ -217,7 +299,7 @@ No other changes yet.
 </details>
 
 ```grain
-toString : Buffer -> String
+toString : (buffer: Buffer) => String
 ```
 
 Returns a copy of the current contents of the buffer as a string.
@@ -234,6 +316,14 @@ Returns:
 |----|-----------|
 |`String`|A string made with data copied from the buffer|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addString("HelloWorld", buf)
+assert Buffer.toString(buf) == "HelloWorld"
+```
+
 ### Buffer.**toStringSlice**
 
 <details disabled>
@@ -242,7 +332,7 @@ No other changes yet.
 </details>
 
 ```grain
-toStringSlice : (Number, Number, Buffer) -> String
+toStringSlice : (start: Number, length: Number, buffer: Buffer) => String
 ```
 
 Returns a copy of a subset of the current contents of the buffer as a string.
@@ -261,6 +351,14 @@ Returns:
 |----|-----------|
 |`String`|A string made with a subset of data copied from the buffer|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addString("HelloWorld", buf)
+assert Buffer.toStringSlice(0, 5, buf) == "Hello"
+```
+
 ### Buffer.**addBytes**
 
 <details disabled>
@@ -269,7 +367,7 @@ No other changes yet.
 </details>
 
 ```grain
-addBytes : (Bytes, Buffer) -> Void
+addBytes : (bytes: Bytes, buffer: Buffer) => Void
 ```
 
 Appends a byte sequence to a buffer.
@@ -281,6 +379,14 @@ Parameters:
 |`bytes`|`Bytes`|The byte sequence to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addBytes(b"test", buf)
+assert Buffer.toBytes(buf) == b"test"
+```
+
 ### Buffer.**addString**
 
 <details disabled>
@@ -289,7 +395,7 @@ No other changes yet.
 </details>
 
 ```grain
-addString : (String, Buffer) -> Void
+addString : (string: String, buffer: Buffer) => Void
 ```
 
 Appends the bytes of a string to a buffer.
@@ -301,6 +407,14 @@ Parameters:
 |`string`|`String`|The string to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addString("Hello", buf)
+assert Buffer.toString(buf) == "Hello"
+```
+
 ### Buffer.**addChar**
 
 <details disabled>
@@ -309,10 +423,10 @@ No other changes yet.
 </details>
 
 ```grain
-addChar : (Char, Buffer) -> Void
+addChar : (char: Char, buffer: Buffer) => Void
 ```
 
-Appends the bytes of a char to a buffer.
+Appends the bytes of a character to a buffer.
 
 Parameters:
 
@@ -321,6 +435,42 @@ Parameters:
 |`char`|`Char`|The character to append to the buffer|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addChar('H', buf)
+assert Buffer.toString(buf) == "H"
+```
+
+### Buffer.**addCharFromCodePoint**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+addCharFromCodePoint : (codePoint: Number, buffer: Buffer) => Void
+```
+
+Appends a character represented by a code point to a buffer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`codePoint`|`Number`|The code point to append to the buffer|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addCharFromCodePoint(72, buf)
+assert Buffer.toString(buf) == "H"
+```
+
 ### Buffer.**addStringSlice**
 
 <details>
@@ -336,7 +486,8 @@ Parameters:
 </details>
 
 ```grain
-addStringSlice : (Number, Number, String, Buffer) -> Void
+addStringSlice :
+  (start: Number, end: Number, string: String, buffer: Buffer) => Void
 ```
 
 Appends the bytes of a subset of a string to a buffer.
@@ -350,6 +501,14 @@ Parameters:
 |`string`|`String`|The string to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addStringSlice(0, 5, "HelloWorld", buf)
+assert Buffer.toString(buf) == "Hello"
+```
+
 ### Buffer.**addBytesSlice**
 
 <details disabled>
@@ -358,7 +517,8 @@ No other changes yet.
 </details>
 
 ```grain
-addBytesSlice : (Number, Number, Bytes, Buffer) -> Void
+addBytesSlice :
+  (start: Number, length: Number, bytes: Bytes, buffer: Buffer) => Void
 ```
 
 Appends the bytes of a subset of a byte sequence to a buffer.
@@ -381,6 +541,14 @@ Throws:
 * When the `length` is negative
 * When the `length` is greater than the `bytes` length minus `start`
 
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addBytesSlice(0, 5, b"HelloWorld", buf)
+assert Buffer.toString(buf) == "Hello"
+```
+
 ### Buffer.**addBuffer**
 
 <details disabled>
@@ -389,7 +557,7 @@ No other changes yet.
 </details>
 
 ```grain
-addBuffer : (Buffer, Buffer) -> Void
+addBuffer : (srcBuffer: Buffer, dstBuffer: Buffer) => Void
 ```
 
 Appends the bytes of a source buffer to destination buffer.
@@ -403,6 +571,17 @@ Parameters:
 |`srcBuffer`|`Buffer`|The buffer to append|
 |`dstBuffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf1 = Buffer.make(0)
+Buffer.addString("Hello", buf1)
+let buf2 = Buffer.make(0)
+Buffer.addString("World", buf2)
+Buffer.addBuffer(buf2, buf1)
+assert Buffer.toString(buf1) == "HelloWorld"
+```
+
 ### Buffer.**addBufferSlice**
 
 <details disabled>
@@ -411,7 +590,9 @@ No other changes yet.
 </details>
 
 ```grain
-addBufferSlice : (Number, Number, Buffer, Buffer) -> Void
+addBufferSlice :
+  (start: Number, length: Number, srcBuffer: Buffer, dstBuffer: Buffer) =>
+   Void
 ```
 
 Appends the bytes of a part of a buffer to the end of the buffer
@@ -427,19 +608,33 @@ Parameters:
 |`srcBuffer`|`Buffer`|The buffer to append|
 |`dstBuffer`|`Buffer`|The buffer to mutate|
 
-## Binary operations on integers
+Examples:
 
-Functions for encoding and decoding integers stored in a buffer.
+```grain
+let buf1 = Buffer.make(0)
+Buffer.addString("Hello", buf1)
+let buf2 = Buffer.make(0)
+Buffer.addString("HiWorld", buf2)
+Buffer.addBufferSlice(2, 5, buf2, buf1)
+assert Buffer.toString(buf1) == "HelloWorld"
+```
 
-### Buffer.**getInt8S**
+### Buffer.**getInt8**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.6.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.4.0</code></td><td>Originally called `getInt8S`, returning an `Int32`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-getInt8S : (Number, Buffer) -> Int32
+getInt8 : (index: Number, buffer: Buffer) => Int8
 ```
 
 Gets a signed 8-bit integer starting at the given byte index.
@@ -455,7 +650,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Int32`|A 32-bit integer representing a signed 8-bit integer that starts at the given index|
+|`Int8`|A signed 8-bit integer that starts at the given index|
 
 Throws:
 
@@ -465,49 +660,30 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 1` is greater than the buffer size
 
-### Buffer.**getInt8U**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
-</details>
+Examples:
 
 ```grain
-getInt8U : (Number, Buffer) -> Int32
+let buf = Buffer.make(0)
+Buffer.addInt8(1s, buf)
+assert Buffer.getInt8(0, buf) == 1s
 ```
 
-Gets an unsigned 8-bit integer starting at the given byte index.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`index`|`Number`|The byte index to access|
-|`buffer`|`Buffer`|The buffer to access|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Int32`|A 32-bit integer representing an unsigned 8-bit integer that starts at the given index|
-
-Throws:
-
-`IndexOutOfBounds`
-
-* When `index` is negative
-* When `index` is greater than or equal to the buffer size
-* When `index + 1` is greater than the buffer size
-
 ### Buffer.**setInt8**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>`value` argument type changed to `Int8`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-setInt8 : (Number, Int32, Buffer) -> Void
+setInt8 : (index: Number, value: Int8, buffer: Buffer) => Void
 ```
 
 Sets a signed 8-bit integer starting at the given byte index.
@@ -517,7 +693,7 @@ Parameters:
 |param|type|description|
 |-----|----|-----------|
 |`index`|`Number`|The byte index to update|
-|`value`|`Int32`|The value to set|
+|`value`|`Int8`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
 Throws:
@@ -528,15 +704,31 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 1` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setInt8(0, 3s, buf)
+assert Buffer.getInt8(0, buf) == 3s
+```
+
 ### Buffer.**addInt8**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>`value` argument type changed to `Int8`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-addInt8 : (Int32, Buffer) -> Void
+addInt8 : (value: Int8, buffer: Buffer) => Void
 ```
 
 Appends a signed 8-bit integer to a buffer.
@@ -545,55 +737,36 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`Int32`|The value to append|
+|`value`|`Int8`|The value to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
-### Buffer.**getInt16S**
-
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
-</details>
+Examples:
 
 ```grain
-getInt16S : (Number, Buffer) -> Int32
+let buf = Buffer.make(0)
+Buffer.addInt8(2s, buf)
+assert Buffer.getInt8(0, buf) == 2s
 ```
 
-Gets a signed 16-bit integer starting at the given byte index.
-
-Parameters:
-
-|param|type|description|
-|-----|----|-----------|
-|`index`|`Number`|The byte index to access|
-|`buffer`|`Buffer`|The buffer to access|
-
-Returns:
-
-|type|description|
-|----|-----------|
-|`Int32`|A 32-bit integer representing a signed 16-bit integer that starts at the given index|
-
-Throws:
-
-`IndexOutOfBounds`
-
-* When `index` is negative
-* When `index` is greater than or equal to the buffer size
-* When `index + 2` is greater than the buffer size
-
-### Buffer.**getInt16U**
+### Buffer.**getUint8**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.6.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.4.0</code></td><td>Originally called `getInt8U`, returning an `Int32`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-getInt16U : (Number, Buffer) -> Int32
+getUint8 : (index: Number, buffer: Buffer) => Uint8
 ```
 
-Gets an unsigned 16-bit integer starting at the given byte index.
+Gets an unsigned 8-bit integer starting at the given byte index.
 
 Parameters:
 
@@ -606,7 +779,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Int32`|A 32-bit integer representing an unsigned 16-bit integer that starts at the given index|
+|`Uint8`|An unsigned 8-bit integer that starts at the given index|
 
 Throws:
 
@@ -614,27 +787,35 @@ Throws:
 
 * When `index` is negative
 * When `index` is greater than or equal to the buffer size
-* When `index + 2` is greater than the buffer size
+* When `index + 1` is greater than the buffer size
 
-### Buffer.**setInt16**
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addUint8(3us, buf)
+assert Buffer.getUint8(0, buf) == 3us
+```
+
+### Buffer.**setUint8**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
 No other changes yet.
 </details>
 
 ```grain
-setInt16 : (Number, Int32, Buffer) -> Void
+setUint8 : (index: Number, value: Uint8, buffer: Buffer) => Void
 ```
 
-Sets a signed 16-bit integer starting at the given byte index.
+Sets an unsigned 8-bit integer starting at the given byte index.
 
 Parameters:
 
 |param|type|description|
 |-----|----|-----------|
 |`index`|`Number`|The byte index to update|
-|`value`|`Int32`|The value to set|
+|`value`|`Uint8`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
 Throws:
@@ -643,40 +824,64 @@ Throws:
 
 * When `index` is negative
 * When `index` is greater than or equal to the buffer size
-* When `index + 2` is greater than the buffer size
+* When `index + 1` is greater than the buffer size
 
-### Buffer.**addInt16**
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setUint8(4us, buf)
+assert Buffer.getUint8(0, buf) == 4us
+```
+
+### Buffer.**addUint8**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
 No other changes yet.
 </details>
 
 ```grain
-addInt16 : (Int32, Buffer) -> Void
+addUint8 : (value: Uint8, buffer: Buffer) => Void
 ```
 
-Appends a signed 16-bit integer to a buffer.
+Appends an unsigned 8-bit integer to a buffer.
 
 Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`Int32`|The value to append|
+|`value`|`Uint8`|The value to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
-### Buffer.**getInt32**
+Examples:
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
+```grain
+let buf = Buffer.make(32)
+Buffer.addUint8(0us, buf)
+assert Buffer.getUint8(0, buf) == 0us
+```
+
+### Buffer.**getInt16**
+
+<details>
+<summary>Added in <code>0.6.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.4.0</code></td><td>Originally called `getInt16S`, returning an `Int32`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-getInt32 : (Number, Buffer) -> Int32
+getInt16 : (index: Number, buffer: Buffer) => Int16
 ```
 
-Gets a signed 32-bit integer starting at the given byte index.
+Gets a signed 16-bit integer starting at the given byte index.
 
 Parameters:
 
@@ -689,7 +894,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Int32`|A signed 32-bit integer that starts at the given index|
+|`Int16`|A signed 16-bit integer that starts at the given index|
 
 Throws:
 
@@ -697,24 +902,269 @@ Throws:
 
 * When `index` is negative
 * When `index` is greater than or equal to the buffer size
-* When `index + 4` is greater than the buffer size
-
-### Buffer.**setInt32**
+* When `index + 2` is greater than the buffer size
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.4.0</code></summary>
-No other changes yet.
-</details>
+Examples:
 
 ```grain
-setInt32 : (Number, Int32, Buffer) -> Void
+let buf = Buffer.make(32)
+Buffer.addInt16(1S, buf)
+assert Buffer.getInt16(0, buf) == 1S
 ```
 
-Sets a signed 32-bit integer starting at the given byte index.
-
-Parameters:
+### Buffer.**setInt16**
 
-|param|type|description|
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>`value` argument type changed to `Int16`</td></tr>
+</tbody>
+</table>
+</details>
+
+```grain
+setInt16 : (index: Number, value: Int16, buffer: Buffer) => Void
+```
+
+Sets a signed 16-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to update|
+|`value`|`Int16`|The value to set|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 2` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setInt16(5, 1S, buf)
+assert Buffer.getInt16(5, buf) == 1S
+```
+
+### Buffer.**addInt16**
+
+<details>
+<summary>Added in <code>0.4.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.6.0</code></td><td>`value` argument type changed to `Int16`</td></tr>
+</tbody>
+</table>
+</details>
+
+```grain
+addInt16 : (value: Int16, buffer: Buffer) => Void
+```
+
+Appends a signed 16-bit integer to a buffer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`value`|`Int16`|The value to append|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addInt16(2S, buf)
+assert Buffer.getInt16(0, buf) == 2S
+```
+
+### Buffer.**getUint16**
+
+<details>
+<summary>Added in <code>0.6.0</code></summary>
+<table>
+<thead>
+<tr><th>version</th><th>changes</th></tr>
+</thead>
+<tbody>
+<tr><td><code>0.4.0</code></td><td>Originally called `getInt16U`, returning an `Int32`</td></tr>
+</tbody>
+</table>
+</details>
+
+```grain
+getUint16 : (index: Number, buffer: Buffer) => Uint16
+```
+
+Gets an unsigned 16-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to access|
+|`buffer`|`Buffer`|The buffer to access|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Uint16`|An unsigned 16-bit integer that starts at the given index|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 2` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addUint16(1uS, buf)
+assert Buffer.getUint16(0, buf) == 1uS
+```
+
+### Buffer.**setUint16**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+setUint16 : (index: Number, value: Uint16, buffer: Buffer) => Void
+```
+
+Sets an unsigned 16-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to update|
+|`value`|`Uint16`|The value to set|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 2` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setUint16(0, 1uS, buf)
+assert Buffer.getUint16(0, buf) == 1uS
+```
+
+### Buffer.**addUint16**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+addUint16 : (value: Uint16, buffer: Buffer) => Void
+```
+
+Appends an unsigned 16-bit integer to a buffer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`value`|`Uint16`|The value to append|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addUint16(0, 2uS, buf)
+assert Buffer.getUint16(0, buf) == 2uS
+```
+
+### Buffer.**getInt32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+getInt32 : (index: Number, buffer: Buffer) => Int32
+```
+
+Gets a signed 32-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to access|
+|`buffer`|`Buffer`|The buffer to access|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Int32`|A signed 32-bit integer that starts at the given index|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(0)
+Buffer.addInt32(1l, buf)
+assert Buffer.getInt32(0, buf) == 1l
+```
+
+### Buffer.**setInt32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.4.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+setInt32 : (index: Number, value: Int32, buffer: Buffer) => Void
+```
+
+Sets a signed 32-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
 |-----|----|-----------|
 |`index`|`Number`|The byte index to update|
 |`value`|`Int32`|The value to set|
@@ -728,6 +1178,15 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 4` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(64)
+Buffer.addString("Hello World", buf)
+Buffer.setInt32(3, 1l, buf)
+assert Buffer.getInt32(3, buf) == 1l
+```
+
 ### Buffer.**addInt32**
 
 <details disabled>
@@ -736,7 +1195,7 @@ No other changes yet.
 </details>
 
 ```grain
-addInt32 : (Int32, Buffer) -> Void
+addInt32 : (value: Int32, buffer: Buffer) => Void
 ```
 
 Appends a signed 32-bit integer to a buffer.
@@ -748,6 +1207,122 @@ Parameters:
 |`value`|`Int32`|The value to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(64)
+Buffer.addInt32(1l, buf)
+assert Buffer.getInt32(0, buf) == 1l
+```
+
+### Buffer.**getUint32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+getUint32 : (index: Number, buffer: Buffer) => Uint32
+```
+
+Gets an unsigned 32-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to access|
+|`buffer`|`Buffer`|The buffer to access|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Uint32`|An unsigned 32-bit integer that starts at the given index|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addUint32(1ul, buf)
+assert Buffer.getUint32(0, buf) == 1ul
+```
+
+### Buffer.**setUint32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+setUint32 : (index: Number, value: Uint32, buffer: Buffer) => Void
+```
+
+Sets an unsigned 32-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to update|
+|`value`|`Uint32`|The value to set|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 4` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setUint32(0, 1ul, buf)
+assert Buffer.getUint32(0, buf) == 1ul
+```
+
+### Buffer.**addUint32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+addUint32 : (value: Uint32, buffer: Buffer) => Void
+```
+
+Appends an unsigned 32-bit integer to a buffer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`value`|`Uint32`|The value to append|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addUint32(1ul, buf)
+assert Buffer.getUint32(0, buf) == 1ul
+```
+
 ### Buffer.**getFloat32**
 
 <details disabled>
@@ -756,7 +1331,7 @@ No other changes yet.
 </details>
 
 ```grain
-getFloat32 : (Number, Buffer) -> Float32
+getFloat32 : (index: Number, buffer: Buffer) => Float32
 ```
 
 Gets a 32-bit float starting at the given byte index.
@@ -782,6 +1357,14 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 4` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addFloat32(1.0f, buf)
+assert Buffer.getFloat32(0, buf) == 1.0f
+```
+
 ### Buffer.**setFloat32**
 
 <details disabled>
@@ -790,7 +1373,7 @@ No other changes yet.
 </details>
 
 ```grain
-setFloat32 : (Number, Float32, Buffer) -> Void
+setFloat32 : (index: Number, value: Float32, buffer: Buffer) => Void
 ```
 
 Sets a 32-bit float starting at the given byte index.
@@ -811,6 +1394,15 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 4` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setFloat32(0, 1.0f, buf)
+assert Buffer.getFloat32(0, buf) == 1.0f
+```
+
 ### Buffer.**addFloat32**
 
 <details disabled>
@@ -819,7 +1411,7 @@ No other changes yet.
 </details>
 
 ```grain
-addFloat32 : (Float32, Buffer) -> Void
+addFloat32 : (value: Float32, buffer: Buffer) => Void
 ```
 
 Appends a 32-bit float to a buffer.
@@ -831,6 +1423,14 @@ Parameters:
 |`value`|`Float32`|The value to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addFloat32(1.0f, buf)
+assert Buffer.getFloat32(0, buf) == 1.0f
+```
+
 ### Buffer.**getInt64**
 
 <details disabled>
@@ -839,7 +1439,7 @@ No other changes yet.
 </details>
 
 ```grain
-getInt64 : (Number, Buffer) -> Int64
+getInt64 : (index: Number, buffer: Buffer) => Int64
 ```
 
 Gets a signed 64-bit integer starting at the given byte index.
@@ -865,6 +1465,14 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 8` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addInt64(1L, buf)
+assert Buffer.getInt64(0, buf) == 1L
+```
+
 ### Buffer.**setInt64**
 
 <details disabled>
@@ -873,7 +1481,7 @@ No other changes yet.
 </details>
 
 ```grain
-setInt64 : (Number, Int64, Buffer) -> Void
+setInt64 : (index: Number, value: Int64, buffer: Buffer) => Void
 ```
 
 Sets a signed 64-bit integer starting at the given byte index.
@@ -894,6 +1502,15 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 8` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setInt64(0, 1L, buf)
+assert Buffer.getInt64(0, buf) == 1L
+```
+
 ### Buffer.**addInt64**
 
 <details disabled>
@@ -902,7 +1519,7 @@ No other changes yet.
 </details>
 
 ```grain
-addInt64 : (Int64, Buffer) -> Void
+addInt64 : (value: Int64, buffer: Buffer) => Void
 ```
 
 Appends a signed 64-bit integer to a buffer.
@@ -914,6 +1531,122 @@ Parameters:
 |`value`|`Int64`|The value to set|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addInt64(1L, buf)
+assert Buffer.getInt64(0, buf) == 1L
+```
+
+### Buffer.**getUint64**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+getUint64 : (index: Number, buffer: Buffer) => Uint64
+```
+
+Gets an unsigned 64-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to access|
+|`buffer`|`Buffer`|The buffer to access|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`Uint64`|An unsigned 64-bit integer that starts at the given index|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 8` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addUint64(1uL, buf)
+assert Buffer.getUint64(0, buf) == 1uL
+```
+
+### Buffer.**setUint64**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+setUint64 : (index: Number, value: Uint64, buffer: Buffer) => Void
+```
+
+Sets an unsigned 64-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to update|
+|`value`|`Uint64`|The value to set|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index` is greater than or equal to the buffer size
+* When `index + 8` is greater than the buffer size
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setUint64(0, 1uL, buf)
+assert Buffer.getUint64(0, buf) == 1uL
+```
+
+### Buffer.**addUint64**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+addUint64 : (value: Uint64, buffer: Buffer) => Void
+```
+
+Appends an unsigned 64-bit integer to a buffer.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`value`|`Uint64`|The value to set|
+|`buffer`|`Buffer`|The buffer to mutate|
+
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addUint64(1uL, buf)
+assert Buffer.getUint64(0, buf) == 1uL
+```
+
 ### Buffer.**getFloat64**
 
 <details disabled>
@@ -922,7 +1655,7 @@ No other changes yet.
 </details>
 
 ```grain
-getFloat64 : (Number, Buffer) -> Float64
+getFloat64 : (index: Number, buffer: Buffer) => Float64
 ```
 
 Gets a 64-bit float starting at the given byte index.
@@ -948,6 +1681,14 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 8` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addFloat64(1.0F, buf)
+assert Buffer.getFloat64(0, buf) == 1.0F
+```
+
 ### Buffer.**setFloat64**
 
 <details disabled>
@@ -956,7 +1697,7 @@ No other changes yet.
 </details>
 
 ```grain
-setFloat64 : (Number, Float64, Buffer) -> Void
+setFloat64 : (index: Number, value: Float64, buffer: Buffer) => Void
 ```
 
 Sets a 64-bit float starting at the given byte index.
@@ -977,6 +1718,15 @@ Throws:
 * When `index` is greater than or equal to the buffer size
 * When `index + 8` is greater than the buffer size
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addString("Hello World", buf)
+Buffer.setFloat64(0, 1.0F, buf)
+assert Buffer.getFloat64(0, buf) == 1.0F
+```
+
 ### Buffer.**addFloat64**
 
 <details disabled>
@@ -985,7 +1735,7 @@ No other changes yet.
 </details>
 
 ```grain
-addFloat64 : (Float64, Buffer) -> Void
+addFloat64 : (value: Float64, buffer: Buffer) => Void
 ```
 
 Appends a 64-bit float to a buffer.
@@ -997,3 +1747,11 @@ Parameters:
 |`value`|`Float64`|The value to append|
 |`buffer`|`Buffer`|The buffer to mutate|
 
+Examples:
+
+```grain
+let buf = Buffer.make(32)
+Buffer.addFloat64(1.0F, buf)
+assert Buffer.getFloat64(0, buf) == 1.0F
+```
+