functionalscript 0.3.10 → 0.3.12

package/types/string/module.f.js

@@ -1,3 +1,20 @@
+/**
+ * Utility functions for working with strings and lists of strings.
+ *
+ * @module
+ *
+ * @example
+ *
+ * ```js
+ * import { join, concat, repeat, cmp } from './module.f.ts'
+ *
+ * const words = ['hello', 'world']
+ * join(' ')(words) // 'hello world'
+ * concat(words) // 'helloworld'
+ * repeat('abc')(3) // 'abcabcabc'
+ * cmp('apple')('banana') // -1
+ * ```
+ */
 import { reduce as listReduce, repeat as listRepeat } from "../list/module.f.js";
 import { compose } from "../function/module.f.js";
 import { unsafeCmp } from "../function/compare/module.f.js";

package/types/string/test.f.d.ts

@@ -1,4 +1,5 @@
 declare const _default: {
+    example: () => void;
     join: {
         0: () => void;
         1: () => void;

package/types/string/test.f.js

@@ -1,6 +1,21 @@
 import { join, concat, repeat, cmp } from "./module.f.js";
 import { repeat as repeatList } from "../list/module.f.js";
 export default {
+    example: () => {
+        const words = ['hello', 'world'];
+        if (join(' ')(words) !== 'hello world') {
+            throw 0;
+        }
+        if (concat(words) !== 'helloworld') {
+            throw 1;
+        }
+        if (repeat('abc')(3) !== 'abcabcabc') {
+            throw 2;
+        }
+        if (cmp('apple')('banana') !== -1) {
+            throw 3;
+        }
+    },
     join: {
         0: () => {
             const result = join('/')([]);

package/types/string_set/module.f.d.ts

@@ -1,3 +1,24 @@
+/**
+ * A set of strings implemented as a B-Tree.
+ *
+ * @module
+ *
+ * @example
+ *
+ * ```js
+ * import { set, contains, remove, fromValues, values, empty } from './module.d.ts';
+ *
+ * let mySet = fromValues(['apple', 'banana', 'cherry']);
+ * if (!contains('banana')(mySet)) { throw '1' }
+ * if (contains('date')(mySet)) { throw '2' }
+ *
+ * mySet = set('date')(mySet);
+ * if (!contains('date')(mySet)) { throw '3' }
+ *
+ * mySet = remove('banana')(mySet);
+ * if (contains('banana')(mySet)) { throw '4' }
+ * ```
+ */
 import type { Tree } from '../btree/types/module.f.ts';
 import { type List } from '../list/module.f.ts';
 export declare const values: (s: StringSet) => List<string>;

package/types/string_set/module.f.js

@@ -1,3 +1,24 @@
+/**
+ * A set of strings implemented as a B-Tree.
+ *
+ * @module
+ *
+ * @example
+ *
+ * ```js
+ * import { set, contains, remove, fromValues, values, empty } from './module.d.ts';
+ *
+ * let mySet = fromValues(['apple', 'banana', 'cherry']);
+ * if (!contains('banana')(mySet)) { throw '1' }
+ * if (contains('date')(mySet)) { throw '2' }
+ *
+ * mySet = set('date')(mySet);
+ * if (!contains('date')(mySet)) { throw '3' }
+ *
+ * mySet = remove('banana')(mySet);
+ * if (contains('banana')(mySet)) { throw '4' }
+ * ```
+ */
 import * as btree from "../btree/module.f.js";
 import { find, isFound } from "../btree/find/module.f.js";
 import { remove as btreeRemove } from "../btree/remove/module.f.js";

package/types/string_set/test.f.d.ts

@@ -1,4 +1,5 @@
 declare const _default: {
+    example: () => void;
     contains: () => void;
     remove: () => void;
 };

package/types/string_set/test.f.js

@@ -1,5 +1,22 @@
-import { contains, remove, set } from "./module.f.js";
+import { contains, fromValues, remove, set } from "./module.f.js";
 export default {
+    example: () => {
+        let mySet = fromValues(['apple', 'banana', 'cherry']);
+        if (!contains('banana')(mySet)) {
+            throw '1';
+        }
+        if (contains('date')(mySet)) {
+            throw '2';
+        }
+        mySet = set('date')(mySet);
+        if (!contains('date')(mySet)) {
+            throw '3';
+        }
+        mySet = remove('banana')(mySet);
+        if (contains('banana')(mySet)) {
+            throw '4';
+        }
+    },
     contains: () => {
         const r = set('hello')(null);
         if (!contains('hello')(r)) {