@grain/stdlib 0.5.12 → 0.6.0

package/bytes.md

@@ -10,12 +10,20 @@ No other changes yet.
 </details>
 
 ```grain
-import Bytes from "bytes"
+from "bytes" include Bytes
+```
+
+```grain
+b"\x00"
+```
+
+```grain
+Bytes.make(1)
 ```
 
 ## Values
 
-Functions for working with the Bytes data type.
+Functions and constants included in the Bytes module.
 
 ### Bytes.**make**
 
@@ -25,7 +33,7 @@ No other changes yet.
 </details>
 
 ```grain
-make : Number -> Bytes
+make : (size: Number) => Bytes
 ```
 
 Creates a new byte sequence of the input size.
@@ -42,6 +50,16 @@ Returns:
 |----|-----------|
 |`Bytes`|The new byte sequence|
 
+Examples:
+
+```grain
+Bytes.make(0) == b"""
+```
+
+```grain
+Bytes.make(1) == b"\x00"
+```
+
 ### Bytes.**empty**
 
 <details disabled>
@@ -55,6 +73,12 @@ empty : Bytes
 
 An empty byte sequence.
 
+Examples:
+
+```grain
+Bytes.empty == b""
+```
+
 ### Bytes.**fromString**
 
 <details disabled>
@@ -63,7 +87,7 @@ No other changes yet.
 </details>
 
 ```grain
-fromString : String -> Bytes
+fromString : (string: String) => Bytes
 ```
 
 Creates a new byte sequence from the input string.
@@ -80,6 +104,12 @@ Returns:
 |----|-----------|
 |`Bytes`|The new byte sequence|
 
+Examples:
+
+```grain
+Bytes.fromString("\x00\x00") == b"\x00\x00"
+```
+
 ### Bytes.**toString**
 
 <details disabled>
@@ -88,7 +118,7 @@ No other changes yet.
 </details>
 
 ```grain
-toString : Bytes -> String
+toString : (bytes: Bytes) => String
 ```
 
 Creates a new string from the input bytes.
@@ -105,6 +135,16 @@ Returns:
 |----|-----------|
 |`String`|The string representation of the bytes|
 
+Examples:
+
+```grain
+Bytes.toString(b"\x48\x65\x6c\x6c\x6f\x20\x57\x6f\x72\x6c\x64") == "Hello World"
+```
+
+```grain
+Bytes.toString(b"Hello World") == "Hello World"
+```
+
 ### Bytes.**length**
 
 <details disabled>
@@ -113,7 +153,7 @@ No other changes yet.
 </details>
 
 ```grain
-length : Bytes -> Number
+length : (bytes: Bytes) => Number
 ```
 
 Returns the length of a byte sequence.
@@ -130,6 +170,16 @@ Returns:
 |----|-----------|
 |`Number`|The number of bytes|
 
+Examples:
+
+```grain
+Bytes.length(b"") == 0
+```
+
+```grain
+Bytes.length(b"\x48") == 1
+```
+
 ### Bytes.**copy**
 
 <details disabled>
@@ -138,7 +188,7 @@ No other changes yet.
 </details>
 
 ```grain
-copy : Bytes -> Bytes
+copy : (bytes: Bytes) => Bytes
 ```
 
 Creates a new byte sequence that contains the same bytes as the input byte sequence.
@@ -155,6 +205,12 @@ Returns:
 |----|-----------|
 |`Bytes`|The new byte sequence|
 
+Examples:
+
+```grain
+Bytes.copy(b"\x48") == b"\x48"
+```
+
 ### Bytes.**slice**
 
 <details disabled>
@@ -163,7 +219,7 @@ No other changes yet.
 </details>
 
 ```grain
-slice : (Number, Number, Bytes) -> Bytes
+slice : (start: Number, length: Number, bytes: Bytes) => Bytes
 ```
 
 Returns a copy of a subset of the input byte sequence.
@@ -188,6 +244,14 @@ Throws:
 
 * When `start + length` is greater than the bytes size
 
+Examples:
+
+```grain
+assert Bytes.toString(
+  Bytes.slice(0, 5, b"\x48\x65\x6c\x6c\x6f\x20\x57\x6f\x72\x6c\x64")
+) == "Hello"
+```
+
 ### Bytes.**resize**
 
 <details disabled>
@@ -196,7 +260,7 @@ No other changes yet.
 </details>
 
 ```grain
-resize : (Number, Number, Bytes) -> Bytes
+resize : (left: Number, right: Number, bytes: Bytes) => Bytes
 ```
 
 Returns a copy of a byte sequence with bytes added or removed from the beginning and/or end.
@@ -223,6 +287,12 @@ Throws:
 
 * When the new size is negative
 
+Examples:
+
+```grain
+Bytes.length(Bytes.resize(0, 3, b"")) == 3
+```
+
 ### Bytes.**move**
 
 <details disabled>
@@ -231,7 +301,9 @@ No other changes yet.
 </details>
 
 ```grain
-move : (Number, Number, Number, Bytes, Bytes) -> Void
+move :
+  (srcIndex: Number, dstIndex: Number, length: Number, src: Bytes, dst: Bytes) =>
+   Void
 ```
 
 Copies a range of bytes from a source byte sequence to a given location
@@ -243,7 +315,7 @@ Parameters:
 |-----|----|-----------|
 |`srcIndex`|`Number`|The starting index to copy bytes from|
 |`dstIndex`|`Number`|The starting index to copy bytes into|
-|`length`|`Number`|The amount of bytes to copy from the source buffer|
+|`length`|`Number`|The amount of bytes to copy from the source byte sequence|
 |`src`|`Bytes`|The source byte sequence|
 |`dst`|`Bytes`|The destination byte sequence|
 
@@ -254,6 +326,14 @@ Throws:
 * When `srcIndex + length` is greater than the `src` bytes size
 * When the `dstIndex + length` is greater than the `dst` bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(5)
+Bytes.move(0, 0, 5, b"\x48\x64\x6c\x6f\x20\x57\x6f\x72\x6c\x64", bytes)
+assert Bytes.toString(bytes) == "Hello"
+```
+
 ### Bytes.**concat**
 
 <details disabled>
@@ -262,7 +342,7 @@ No other changes yet.
 </details>
 
 ```grain
-concat : (Bytes, Bytes) -> Bytes
+concat : (bytes1: Bytes, bytes2: Bytes) => Bytes
 ```
 
 Creates a new byte sequence that contains the bytes of both byte sequences.
@@ -280,15 +360,30 @@ Returns:
 |----|-----------|
 |`Bytes`|The new byte sequence|
 
+Examples:
+
+```grain
+let helloBytes = Bytes.fromString("Hello ")
+let worldBytes = Bytes.fromString("World")
+assert Bytes.toString(Bytes.concat(helloBytes, worldBytes)) == "Hello World"
+```
+
 ### Bytes.**fill**
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
-No other changes yet.
+<details>
+<summary>Added in <code>0.3.2</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 `Uint8`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-fill : (Int32, Bytes) -> Void
+fill : (value: Uint8, bytes: Bytes) => Void
 ```
 
 Replaces all bytes in a byte sequnce with the new value provided.
@@ -297,9 +392,17 @@ Parameters:
 
 |param|type|description|
 |-----|----|-----------|
-|`value`|`Int32`|The value replacing each byte|
+|`value`|`Uint8`|The value replacing each byte|
 |`bytes`|`Bytes`|The byte sequence to update|
 
+Examples:
+
+```grain
+let bytes = Bytes.make(5)
+Bytes.fill(1us, bytes)
+assert bytes == b"\x01\x01\x01\x01\x01"
+```
+
 ### Bytes.**clear**
 
 <details disabled>
@@ -308,7 +411,7 @@ No other changes yet.
 </details>
 
 ```grain
-clear : Bytes -> Void
+clear : (bytes: Bytes) => Void
 ```
 
 Replaces all bytes in a byte sequence with zeroes.
@@ -319,19 +422,31 @@ Parameters:
 |-----|----|-----------|
 |`bytes`|`Bytes`|The byte sequence to clear|
 
-## Binary operations on integers
+Examples:
 
-Functions for encoding and decoding integers stored in a byte sequence.
-
-### Bytes.**getInt8S**
+```grain
+let bytes = Bytes.make(5)
+Bytes.fill(1us, bytes)
+Bytes.clear(bytes)
+assert bytes == b"\x00\x00\x00\x00\x00"
+```
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
-No other changes yet.
+### Bytes.**getInt8**
+
+<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.3.2</code></td><td>Originally called `getInt8S`, returning an `Int32`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-getInt8S : (Number, Bytes) -> Int32
+getInt8 : (index: Number, bytes: Bytes) => Int8
 ```
 
 Gets a signed 8-bit integer starting at the given byte index.
@@ -347,7 +462,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:
 
@@ -356,15 +471,73 @@ Throws:
 * When `index` is negative
 * When `index + 1` is greater than the bytes size
 
-### Bytes.**getInt8U**
+Examples:
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
-No other changes yet.
+```grain
+let bytes = Bytes.make(1)
+Bytes.setInt8(0, 1s, bytes)
+assert Bytes.getInt8(0, bytes) == 1s
+```
+
+### Bytes.**setInt8**
+
+<details>
+<summary>Added in <code>0.3.2</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
-getInt8U : (Number, Bytes) -> Int32
+setInt8 : (index: Number, value: Int8, bytes: Bytes) => Void
+```
+
+Sets a signed 8-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to update|
+|`value`|`Int8`|The value to set|
+|`bytes`|`Bytes`|The byte sequence to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 1` is greater than the bytes size
+
+Examples:
+
+```grain
+let bytes = Bytes.make(1)
+Bytes.setInt8(0, 2s, bytes)
+assert Bytes.getInt8(0, bytes) == 2s
+```
+
+### Bytes.**getUint8**
+
+<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.3.2</code></td><td>Originally called `getInt8U`, returning an `Int32`</td></tr>
+</tbody>
+</table>
+</details>
+
+```grain
+getUint8 : (index: Number, bytes: Bytes) => Uint8
 ```
 
 Gets an unsigned 8-bit integer starting at the given byte index.
@@ -380,7 +553,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Int32`|A 32-bit integer representing an unsigned 8-bit integer that starts at the given index|
+|`Uint8`|An unsigned 8-bit integer that starts at the given index|
 
 Throws:
 
@@ -389,25 +562,33 @@ Throws:
 * When `index` is negative
 * When `index + 1` is greater than the bytes size
 
-### Bytes.**setInt8**
+Examples:
+
+```grain
+let bytes = Bytes.make(1)
+Bytes.setUint8(0, 1us, bytes)
+assert Bytes.getUint8(0, bytes) == 1us
+```
+
+### Bytes.**setUint8**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
 No other changes yet.
 </details>
 
 ```grain
-setInt8 : (Number, Int32, Bytes) -> Void
+setUint8 : (index: Number, value: Uint8, bytes: Bytes) => Void
 ```
 
-Sets a signed 8-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|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
 Throws:
@@ -417,15 +598,30 @@ Throws:
 * When `index` is negative
 * When `index + 1` is greater than the bytes size
 
-### Bytes.**getInt16S**
+Examples:
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
-No other changes yet.
+```grain
+let bytes = Bytes.make(2)
+Bytes.setUint8(1, 2us, bytes)
+assert Bytes.getUint8(1, bytes) == 2us
+```
+
+### Bytes.**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.3.2</code></td><td>Originally called `getInt16S`, returning an `Int32`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-getInt16S : (Number, Bytes) -> Int32
+getInt16 : (index: Number, bytes: Bytes) => Int16
 ```
 
 Gets a signed 16-bit integer starting at the given byte index.
@@ -441,7 +637,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Int32`|A 32-bit integer representing a signed 16-bit integer that starts at the given index|
+|`Int16`|A signed 16-bit integer that starts at the given index|
 
 Throws:
 
@@ -450,15 +646,73 @@ Throws:
 * When `index` is negative
 * When `index + 2` is greater than the bytes size
 
-### Bytes.**getInt16U**
+Examples:
 
-<details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
-No other changes yet.
+```grain
+let bytes = Bytes.make(2)
+Bytes.setInt16(0, -2S, bytes)
+assert Bytes.getInt16(0, bytes) == -2S
+```
+
+### Bytes.**setInt16**
+
+<details>
+<summary>Added in <code>0.3.2</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, bytes: Bytes) => 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|
+|`bytes`|`Bytes`|The byte sequence to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 2` is greater than the bytes size
+
+Examples:
+
+```grain
+let bytes = Bytes.make(2)
+Bytes.setInt16(0, -1S, bytes)
+assert Bytes.getInt16(0, bytes) == -1S
+```
+
+### Bytes.**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.3.2</code></td><td>Originally called `getInt16U`, returning an `Int32`</td></tr>
+</tbody>
+</table>
 </details>
 
 ```grain
-getInt16U : (Number, Bytes) -> Int32
+getUint16 : (index: Number, bytes: Bytes) => Uint16
 ```
 
 Gets an unsigned 16-bit integer starting at the given byte index.
@@ -474,7 +728,7 @@ Returns:
 
 |type|description|
 |----|-----------|
-|`Int32`|A 32-bit integer representing an unsigned 16-bit integer that starts at the given index|
+|`Uint16`|An unsigned 16-bit integer that starts at the given index|
 
 Throws:
 
@@ -483,25 +737,33 @@ Throws:
 * When `index` is negative
 * When `index + 2` is greater than the bytes size
 
-### Bytes.**setInt16**
+Examples:
+
+```grain
+let bytes = Bytes.make(2)
+Bytes.setUint16(0, 2uS, bytes)
+assert Bytes.getUint16(0, bytes) == 2uS
+```
+
+### Bytes.**setUint16**
 
 <details disabled>
-<summary tabindex="-1">Added in <code>0.3.2</code></summary>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
 No other changes yet.
 </details>
 
 ```grain
-setInt16 : (Number, Int32, Bytes) -> Void
+setUint16 : (index: Number, value: Uint16, bytes: Bytes) => Void
 ```
 
-Sets a signed 16-bit integer starting at the given byte index.
+Sets an unsigned 16-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`|`Uint16`|The value to set|
 |`bytes`|`Bytes`|The byte sequence to mutate|
 
 Throws:
@@ -511,6 +773,14 @@ Throws:
 * When `index` is negative
 * When `index + 2` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(2)
+Bytes.setUint16(0, 2uS, bytes)
+assert Bytes.getUint16(0, bytes) == 2uS
+```
+
 ### Bytes.**getInt32**
 
 <details disabled>
@@ -519,7 +789,7 @@ No other changes yet.
 </details>
 
 ```grain
-getInt32 : (Number, Bytes) -> Int32
+getInt32 : (index: Number, bytes: Bytes) => Int32
 ```
 
 Gets a signed 32-bit integer starting at the given byte index.
@@ -544,6 +814,14 @@ Throws:
 * When `index` is negative
 * When `index + 4` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(4)
+Bytes.setInt32(0, 1l, bytes)
+assert Bytes.getInt32(0, bytes) == 1l
+```
+
 ### Bytes.**setInt32**
 
 <details disabled>
@@ -552,7 +830,7 @@ No other changes yet.
 </details>
 
 ```grain
-setInt32 : (Number, Int32, Bytes) -> Void
+setInt32 : (index: Number, value: Int32, bytes: Bytes) => Void
 ```
 
 Sets a signed 32-bit integer starting at the given byte index.
@@ -572,6 +850,91 @@ Throws:
 * When `index` is negative
 * When `index + 4` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(4)
+Bytes.setInt32(0, 1l, bytes)
+assert Bytes.getInt32(0, bytes) == 1l
+```
+
+### Bytes.**getUint32**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+getUint32 : (index: Number, bytes: Bytes) => Uint32
+```
+
+Gets an unsigned 32-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to access|
+|`bytes`|`Bytes`|The byte sequence 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 + 4` is greater than the bytes size
+
+Examples:
+
+```grain
+let bytes = Bytes.make(4)
+Bytes.setUint32(0, 1ul, bytes)
+assert Bytes.getUint32(0, bytes) == 1ul
+```
+
+### Bytes.**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, bytes: Bytes) => 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|
+|`bytes`|`Bytes`|The byte sequence to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 4` is greater than the bytes size
+
+Examples:
+
+```grain
+let bytes = Bytes.make(4)
+Bytes.setUint32(0, 1ul, bytes)
+assert Bytes.getUint32(0, bytes) == 1ul
+```
+
 ### Bytes.**getFloat32**
 
 <details disabled>
@@ -580,7 +943,7 @@ No other changes yet.
 </details>
 
 ```grain
-getFloat32 : (Number, Bytes) -> Float32
+getFloat32 : (index: Number, bytes: Bytes) => Float32
 ```
 
 Gets a 32-bit float starting at the given byte index.
@@ -605,6 +968,14 @@ Throws:
 * When `index` is negative
 * When `index + 4` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(4)
+Bytes.setFloat32(0, 1.0f, bytes)
+assert Bytes.getFloat32(0, bytes) == 1.0f
+```
+
 ### Bytes.**setFloat32**
 
 <details disabled>
@@ -613,7 +984,7 @@ No other changes yet.
 </details>
 
 ```grain
-setFloat32 : (Number, Float32, Bytes) -> Void
+setFloat32 : (index: Number, value: Float32, bytes: Bytes) => Void
 ```
 
 Sets a 32-bit float starting at the given byte index.
@@ -633,6 +1004,14 @@ Throws:
 * When `index` is negative
 * When `index + 4` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(4)
+Bytes.setFloat32(0, 1.0f, bytes)
+assert Bytes.getFloat32(0, bytes) == 1.0f
+```
+
 ### Bytes.**getInt64**
 
 <details disabled>
@@ -641,7 +1020,7 @@ No other changes yet.
 </details>
 
 ```grain
-getInt64 : (Number, Bytes) -> Int64
+getInt64 : (index: Number, bytes: Bytes) => Int64
 ```
 
 Gets a signed 64-bit integer starting at the given byte index.
@@ -666,6 +1045,14 @@ Throws:
 * When `index` is negative
 * When `index + 8` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(8)
+Bytes.setInt64(0, 1L, bytes)
+assert Bytes.getInt64(0, bytes) == 1L
+```
+
 ### Bytes.**setInt64**
 
 <details disabled>
@@ -674,7 +1061,7 @@ No other changes yet.
 </details>
 
 ```grain
-setInt64 : (Number, Int64, Bytes) -> Void
+setInt64 : (index: Number, value: Int64, bytes: Bytes) => Void
 ```
 
 Sets a signed 64-bit integer starting at the given byte index.
@@ -694,6 +1081,91 @@ Throws:
 * When `index` is negative
 * When `index + 8` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(8)
+Bytes.setInt64(0, 1L, bytes)
+assert Bytes.getInt64(0, bytes) == 1L
+```
+
+### Bytes.**getUint64**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.0</code></summary>
+No other changes yet.
+</details>
+
+```grain
+getUint64 : (index: Number, bytes: Bytes) => Uint64
+```
+
+Gets an unsigned 64-bit integer starting at the given byte index.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`index`|`Number`|The byte index to access|
+|`bytes`|`Bytes`|The byte sequence 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 + 8` is greater than the bytes size
+
+Examples:
+
+```grain
+let bytes = Bytes.make(8)
+Bytes.setUint64(0, 1uL, bytes)
+assert Bytes.getUint64(0, bytes) == 1uL
+```
+
+### Bytes.**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, bytes: Bytes) => 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|
+|`bytes`|`Bytes`|The byte sequence to mutate|
+
+Throws:
+
+`IndexOutOfBounds`
+
+* When `index` is negative
+* When `index + 8` is greater than the bytes size
+
+Examples:
+
+```grain
+let bytes = Bytes.make(8)
+Bytes.setUint64(0, 1uL, bytes)
+assert Bytes.getUint64(0, bytes) == 1uL
+```
+
 ### Bytes.**getFloat64**
 
 <details disabled>
@@ -702,7 +1174,7 @@ No other changes yet.
 </details>
 
 ```grain
-getFloat64 : (Number, Bytes) -> Float64
+getFloat64 : (index: Number, bytes: Bytes) => Float64
 ```
 
 Gets a 64-bit float starting at the given byte index.
@@ -727,6 +1199,14 @@ Throws:
 * When `index` is negative
 * When `index + 8` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(8)
+Bytes.setFloat64(0, 1.0d, bytes)
+assert Bytes.getFloat64(0, bytes) == 1.0d
+```
+
 ### Bytes.**setFloat64**
 
 <details disabled>
@@ -735,7 +1215,7 @@ No other changes yet.
 </details>
 
 ```grain
-setFloat64 : (Number, Float64, Bytes) -> Void
+setFloat64 : (index: Number, value: Float64, bytes: Bytes) => Void
 ```
 
 Sets a 64-bit float starting at the given byte index.
@@ -755,3 +1235,11 @@ Throws:
 * When `index` is negative
 * When `index + 8` is greater than the bytes size
 
+Examples:
+
+```grain
+let bytes = Bytes.make(8)
+Bytes.setFloat64(0, 1.0d, bytes)
+assert Bytes.getFloat64(0, bytes) == 1.0d
+```
+