@grain/stdlib 0.6.5 → 0.7.0

package/string.md

@@ -51,7 +51,7 @@ No other changes yet.
 </details>
 
 ```grain
-concat : (str1: String, str2: String) => String
+concat: (str1: String, str2: String) => String
 ```
 
 Concatenate two strings.
@@ -83,7 +83,7 @@ No other changes yet.
 </details>
 
 ```grain
-length : (string: String) => Number
+length: (string: String) => Number
 ```
 
 Returns the character length of the input string.
@@ -114,7 +114,7 @@ No other changes yet.
 </details>
 
 ```grain
-byteLength : (string: String) => Number
+byteLength: (string: String) => Number
 ```
 
 Returns the byte length of the input string.
@@ -145,7 +145,7 @@ No other changes yet.
 </details>
 
 ```grain
-isEmpty : (string: String) => Bool
+isEmpty: (string: String) => Bool
 ```
 
 Determines if the string contains no characters.
@@ -170,7 +170,7 @@ No other changes yet.
 </details>
 
 ```grain
-indexOf : (search: String, string: String) => Option<Number>
+indexOf: (search: String, string: String) => Option<Number>
 ```
 
 Finds the first position of a substring in the input string.
@@ -202,7 +202,7 @@ No other changes yet.
 </details>
 
 ```grain
-lastIndexOf : (search: String, string: String) => Option<Number>
+lastIndexOf: (search: String, string: String) => Option<Number>
 ```
 
 Finds the last position of a substring in the input string.
@@ -234,7 +234,7 @@ No other changes yet.
 </details>
 
 ```grain
-charCodeAt : (position: Number, string: String) => Number
+charCodeAt: (position: Number, string: String) => Number
 ```
 
 Get the Unicode code point at the position in the input string.
@@ -276,7 +276,7 @@ No other changes yet.
 </details>
 
 ```grain
-charAt : (position: Number, string: String) => Char
+charAt: (position: Number, string: String) => Char
 ```
 
 Get the character at the position in the input string.
@@ -318,7 +318,7 @@ No other changes yet.
 </details>
 
 ```grain
-explode : (string: String) => Array<Char>
+explode: (string: String) => Array<Char>
 ```
 
 Split a string into its Unicode characters.
@@ -355,7 +355,7 @@ No other changes yet.
 </details>
 
 ```grain
-implode : (arr: Array<Char>) => String
+implode: (arr: Array<Char>) => String
 ```
 
 Create a string from an array of characters.
@@ -386,7 +386,7 @@ No other changes yet.
 </details>
 
 ```grain
-reverse : (string: String) => String
+reverse: (string: String) => String
 ```
 
 Create a string that is the given string reversed.
@@ -412,7 +412,7 @@ String.reverse("olleH") == "Hello"
 ### String.**split**
 
 ```grain
-split : (separator: String, string: String) => Array<String>
+split: (separator: String, string: String) => Array<String>
 ```
 
 Split a string by the given separator.
@@ -457,7 +457,7 @@ String.split(" ", "Hello world") == [> "Hello", "world"]
 </details>
 
 ```grain
-slice : (start: Number, ?end: Number, string: String) => String
+slice: (start: Number, ?end: Number, string: String) => String
 ```
 
 Get a portion of a string.
@@ -507,7 +507,7 @@ No other changes yet.
 </details>
 
 ```grain
-contains : (search: String, string: String) => Bool
+contains: (search: String, string: String) => Bool
 ```
 
 Check if a string contains a substring.
@@ -539,7 +539,7 @@ No other changes yet.
 </details>
 
 ```grain
-startsWith : (search: String, string: String) => Bool
+startsWith: (search: String, string: String) => Bool
 ```
 
 Check if a string begins with another string.
@@ -571,7 +571,7 @@ No other changes yet.
 </details>
 
 ```grain
-endsWith : (search: String, string: String) => Bool
+endsWith: (search: String, string: String) => Bool
 ```
 
 Check if a string ends with another string.
@@ -603,7 +603,7 @@ No other changes yet.
 </details>
 
 ```grain
-replaceFirst :
+replaceFirst:
   (searchPattern: String, replacement: String, string: String) => String
 ```
 
@@ -637,7 +637,7 @@ No other changes yet.
 </details>
 
 ```grain
-replaceLast :
+replaceLast:
   (searchPattern: String, replacement: String, string: String) => String
 ```
 
@@ -671,7 +671,7 @@ No other changes yet.
 </details>
 
 ```grain
-replaceAll :
+replaceAll:
   (searchPattern: String, replacement: String, string: String) => String
 ```
 
@@ -712,7 +712,7 @@ String.replaceAll("🌾", "🌎", "Hello 🌾🌾") == "Hello 🌎🌎"
 </details>
 
 ```grain
-encodeAt :
+encodeAt:
   (string: String, encoding: Encoding, dest: Bytes, destPos: Number,
    ?includeBom: Bool) => Bytes
 ```
@@ -757,7 +757,7 @@ Throws:
 </details>
 
 ```grain
-encode : (string: String, encoding: Encoding, ?includeBom: Bool) => Bytes
+encode: (string: String, encoding: Encoding, ?includeBom: Bool) => Bytes
 ```
 
 Encodes the given string using the given encoding scheme.
@@ -791,7 +791,7 @@ Returns:
 </details>
 
 ```grain
-decodeRange :
+decodeRange:
   (bytes: Bytes, encoding: Encoding, start: Number, size: Number,
    ?keepBom: Bool) => String
 ```
@@ -838,7 +838,7 @@ Throws:
 </details>
 
 ```grain
-decode : (bytes: Bytes, encoding: Encoding, ?keepBom: Bool) => String
+decode: (bytes: Bytes, encoding: Encoding, ?keepBom: Bool) => String
 ```
 
 Decodes the given byte sequence into a string using the given encoding scheme.
@@ -865,7 +865,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachCodePoint : (fn: (Number => Void), str: String) => Void
+forEachCodePoint: (fn: (Number => Void), str: String) => Void
 ```
 
 Iterates over Unicode code points in a string.
@@ -891,7 +891,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachCodePointi : (fn: ((Number, Number) => Void), str: String) => Void
+forEachCodePointi: (fn: ((Number, Number) => Void), str: String) => Void
 ```
 
 Iterates over Unicode code points in a string. This is the same as
@@ -919,7 +919,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachChar : (fn: (Char => Void), str: String) => Void
+forEachChar: (fn: (Char => Void), str: String) => Void
 ```
 
 Iterates over Unicode characters in a string.
@@ -945,7 +945,7 @@ No other changes yet.
 </details>
 
 ```grain
-forEachChari : (fn: ((Char, Number) => Void), str: String) => Void
+forEachChari: (fn: ((Char, Number) => Void), str: String) => Void
 ```
 
 Iterates over Unicode characters in a string. This is the same as
@@ -973,7 +973,7 @@ No other changes yet.
 </details>
 
 ```grain
-map : (fn: (Char => Char), str: String) => String
+map: (fn: (Char => Char), str: String) => String
 ```
 
 Builds a new string by mapping Unicode characters.
@@ -999,7 +999,7 @@ No other changes yet.
 </details>
 
 ```grain
-mapi : (fn: ((Char, Number) => Char), str: String) => String
+mapi: (fn: ((Char, Number) => Char), str: String) => String
 ```
 
 Builds a new string by mapping Unicode characters. This is the same as
@@ -1027,7 +1027,7 @@ No other changes yet.
 </details>
 
 ```grain
-trimStart : (string: String) => String
+trimStart: (string: String) => String
 ```
 
 Trims the beginning of a string—removing any leading whitespace characters.
@@ -1058,7 +1058,7 @@ No other changes yet.
 </details>
 
 ```grain
-trimEnd : (string: String) => String
+trimEnd: (string: String) => String
 ```
 
 Trims the end of a string—removing any trailing whitespace characters.
@@ -1089,7 +1089,7 @@ No other changes yet.
 </details>
 
 ```grain
-trim : (string: String) => String
+trim: (string: String) => String
 ```
 
 Trims a string—removing all leading and trailing whitespace characters.
@@ -1120,7 +1120,7 @@ No other changes yet.
 </details>
 
 ```grain
-toAsciiLowercase : (string: String) => String
+toAsciiLowercase: (string: String) => String
 ```
 
 Converts all ASCII uppercase characters in the string to lowercase.
@@ -1151,7 +1151,7 @@ No other changes yet.
 </details>
 
 ```grain
-toAsciiUppercase : (string: String) => String
+toAsciiUppercase: (string: String) => String
 ```
 
 Converts all ASCII lowercase characters in the string to uppercase.
@@ -1174,3 +1174,46 @@ Examples:
 assert String.toAsciiUppercase("aBc123") == "ABC123"
 ```
 
+### String.**repeat**
+
+<details disabled>
+<summary tabindex="-1">Added in <code>0.6.7</code></summary>
+No other changes yet.
+</details>
+
+```grain
+repeat: (count: Number, string: String) => String
+```
+
+Produces a new string by repeating a substring a given number of times.
+
+Parameters:
+
+|param|type|description|
+|-----|----|-----------|
+|`count`|`Number`|The number of times to repeat the string|
+|`string`|`String`|The string to repeat|
+
+Returns:
+
+|type|description|
+|----|-----------|
+|`String`|A string containing the repeated input string|
+
+Throws:
+
+`InvalidArgument(String)`
+
+* When the `count` is not an integer
+* When the `count` is negative
+
+Examples:
+
+```grain
+assert String.repeat(5, "=") == "====="
+```
+
+```grain
+assert String.repeat(0, ".") == ""
+```
+

package/uint16.gr

@@ -2,6 +2,9 @@
  * Utilities for working with the Uint16 type.
  * @example from "uint16" include Uint16
  *
+ * @example 1uS
+ * @example 10uS
+ *
  * @since v0.6.0
  */
 module Uint16
@@ -33,6 +36,9 @@ provide { fromNumber, toNumber }
  * @param number: The value to convert
  * @returns The Int16 represented as a Uint16
  *
+ * @example Uint16.fromInt16(1uS) == 1uS
+ * @example Uint16.fromInt16(-1uS) == 65535uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -49,6 +55,8 @@ provide let fromInt16 = (number: Int16) => {
  * @param value: The value to increment
  * @returns The incremented value
  *
+ * @example Uint16.incr(1uS) == 2uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -65,6 +73,9 @@ provide let incr = (value: Uint16) => {
  * @param value: The value to decrement
  * @returns The decremented value
  *
+ * @example Uint16.decr(1uS) == 0uS
+ * @example Uint16.decr(0uS) == 65535uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -82,6 +93,10 @@ provide let decr = (value: Uint16) => {
  * @param y: The second operand
  * @returns The sum of the two operands
  *
+ * @example
+ * use Uint16.{ (+) }
+ * assert 1uS + 1uS == 2uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -103,6 +118,10 @@ provide let (+) = (x: Uint16, y: Uint16) => {
  * @param y: The second operand
  * @returns The difference of the two operands
  *
+ * @example
+ * use Uint16.{ (-) }
+ * assert 2uS - 1uS == 1uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -121,6 +140,10 @@ provide let (-) = (x: Uint16, y: Uint16) => {
  * @param y: The second operand
  * @returns The product of the two operands
  *
+ * @example
+ * use Uint16.{ (*) }
+ * assert 2uS * 2uS == 4uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -138,6 +161,10 @@ provide let (*) = (x: Uint16, y: Uint16) => {
  * @param y: The second operand
  * @returns The quotient of its operands
  *
+ * @example
+ * use Uint16.{ (/) }
+ * assert 5uS / 2uS == 2uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -155,6 +182,8 @@ provide let (/) = (x: Uint16, y: Uint16) => {
  * @param y: The second operand
  * @returns The remainder of its operands
  *
+ * @example Uint16.rem(5uS, 2uS) == 1uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -172,6 +201,10 @@ provide let rem = (x: Uint16, y: Uint16) => {
  * @param amount: The number of bits to shift by
  * @returns The shifted value
  *
+ * @example
+ * use Uint16.{ (<<) }
+ * assert (5uS << 1uS) == 10uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -191,6 +224,10 @@ provide let (<<) = (value: Uint16, amount: Uint16) => {
  * @param amount: The amount to shift by
  * @returns The shifted value
  *
+ * @example
+ * use Uint16.{ (>>>) }
+ * assert (5uS >>> 1uS) == 2uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -210,6 +247,10 @@ provide let (>>>) = (value: Uint16, amount: Uint16) => {
  * @param y: The second value
  * @returns `true` if the first value is equal to the second value or `false` otherwise
  *
+ * @example
+ * use Uint16.{ (==) }
+ * assert 1uS == 1uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -226,6 +267,10 @@ provide let (==) = (x: Uint16, y: Uint16) => {
  * @param y: The second value
  * @returns `true` if the first value is not equal to the second value or `false` otherwise
  *
+ * @example
+ * use Uint16.{ (!=) }
+ * assert 1uS != 3uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -242,6 +287,10 @@ provide let (!=) = (x: Uint16, y: Uint16) => {
  * @param y: The second value
  * @returns `true` if the first value is less than the second value or `false` otherwise
  *
+ * @example
+ * use Uint16.{ (<) }
+ * assert 1uS < 5uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -258,6 +307,10 @@ provide let (<) = (x: Uint16, y: Uint16) => {
  * @param y: The second value
  * @returns `true` if the first value is greater than the second value or `false` otherwise
  *
+ * @example
+ * use Uint16.{ (>) }
+ * assert 4uS > 2uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -274,6 +327,13 @@ provide let (>) = (x: Uint16, y: Uint16) => {
  * @param y: The second value
  * @returns `true` if the first value is less than or equal to the second value or `false` otherwise
  *
+ * @example
+ * use Uint16.{ (<=) }
+ * assert 1uS <= 2uS
+ * @example
+ * use Uint16.{ (<=) }
+ * assert 1uS <= 1uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -290,6 +350,13 @@ provide let (<=) = (x: Uint16, y: Uint16) => {
  * @param y: The second value
  * @returns `true` if the first value is greater than or equal to the second value or `false` otherwise
  *
+ * @example
+ * use Uint16.{ (>=) }
+ * assert 3uS >= 2uS
+ * @example
+ * use Uint16.{ (>=) }
+ * assert 1uS >= 1uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -305,6 +372,8 @@ provide let (>=) = (x: Uint16, y: Uint16) => {
  * @param value: The given value
  * @returns Containing the inverted bits of the given value
  *
+ * @example Uint16.lnot(5uS) == 65530uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -320,6 +389,10 @@ provide let lnot = (value: Uint16) => {
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of both operands are `1`
  *
+ * @example
+ * use Uint16.{ (&) }
+ * assert (3uS & 4uS) == 0uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -338,6 +411,10 @@ provide let (&) = (x: Uint16, y: Uint16) => {
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of either or both operands are `1`
  *
+ * @example
+ * use Uint16.{ (|) }
+ * assert (3uS | 4uS) == 7uS
+ *
  * @since v0.6.0
  */
 @unsafe
@@ -356,6 +433,10 @@ provide let (|) = (x: Uint16, y: Uint16) => {
  * @param y: The second operand
  * @returns Containing a `1` in each bit position for which the corresponding bits of either but not both operands are `1`
  *
+ * @example
+ * use Uint16.{ (^) }
+ * assert (3uS ^ 5uS) == 6uS
+ *
  * @since v0.6.0
  */
 @unsafe