issue-#57 - Added some notes and reordered prop. declaration in 'type…

…s' module.
functional-jslib · Feb 28, 2024 · 645f10a · 645f10a
1 parent 7c2fecd
commit 645f10a
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/packages/fjl/src/list/README.md b/packages/fjl/src/list/README.md
@@ -0,0 +1,3 @@
+# list/
+
+Contains methods for working with lists (strings, arrays, and/or array-likes (`all`, `foldl`, et al)), methods for working with iterables (`take`, `takeWhile` et al), and some generator methods (`repeat`, `replicate`, `cycle`, and `iterate` (et al)).
diff --git a/packages/fjl/src/list/intersperse.ts b/packages/fjl/src/list/intersperse.ts
@@ -15,6 +15,9 @@ export const
     return out;
   },
 
+  /**
+   * Curried version of `intersperse`.
+   */
   $intersperse = <T = any, TS extends any[] = any[]>(between: T) =>
     (xs: TS): any[] => intersperse(between, xs)
 

diff --git a/packages/fjl/src/types/data.ts b/packages/fjl/src/types/data.ts
@@ -29,8 +29,8 @@ export interface Slice<T = any> extends Iterable<T> {
 
   at(i: number): any;  // @note Method not supported by older versions of typescript versions.
   concat(...items: (Slice<T> | ConcatArray<any>)[]): this;
-  indexOf(x: any): number;
   includes(x: any): boolean;
+  indexOf(x: any): number;
   lastIndexOf(x: any): number;
   slice(start: number, end?: number): this;
 }

diff --git a/.../fjl/tests/list/test-custom-slice-type.ts → packages/fjl/tests/list/test-slice-type.ts b/.../fjl/tests/list/test-custom-slice-type.ts → packages/fjl/tests/list/test-slice-type.ts
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# list/

		Contains methods for working with lists (strings, arrays, and/or array-likes (`all`, `foldl`, et al)), methods for working with iterables (`take`, `takeWhile` et al), and some generator methods (`repeat`, `replicate`, `cycle`, and `iterate` (et al)).