docs: update readme

rob893 · Feb 16, 2022 · 097dee2 · 097dee2
1 parent 5c814f6
commit 097dee2
Show file tree

Hide file tree

Showing 20 changed files with 2,294 additions and 2,276 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,23 @@ This is a library that is a direct translation of [System.Linq](https://docs.mic
 npm i typescript-extended-linq
 ```
 
+To bind the Linq functions to native types (arrays, maps, sets, and strings), do the following at the start of your program:
+
+```typescript
+import { bindLinqToNativeTypes } from 'typescript-extended-linq';
+
+bindLinqToNativeTypes();
+```
+
+You will then be able to see Linq methods on native types:
+
+```typescript
+[1, 2, 3]
+  .where(x => x > 1)
+  .take(1)
+  .toArray();
+```
+
 ## Why use this library?
 
 ### Additional Functionality
@@ -157,7 +174,7 @@ Computes the average of a sequence of numeric values.
 
 Split the elements of a sequence into chunks of size at most chunkSize.
 
-### [concat](https://rob893.github.io/typescript-extended-linq/interfaces/IEnumerable.html#concat)
+### [concatenate](https://rob893.github.io/typescript-extended-linq/interfaces/IEnumerable.html#concatenate)
 
 Concatenates two sequences.
 
@@ -241,7 +258,7 @@ Produces the set intersection of two sequences.
 
 Produces the set intersection of two sequences according to a specified key selector function.
 
-### [join](https://rob893.github.io/typescript-extended-linq/interfaces/IEnumerable.html#join)
+### [innerJoin](https://rob893.github.io/typescript-extended-linq/interfaces/IEnumerable.html#innerJoin)
 
 Performs an inner join by correlating the elements of two sequences based on matching keys.
 
@@ -301,7 +318,7 @@ Adds a value to the beginning of the sequence.
 
 Computes the quantile of a sequence.
 
-### [reverse](https://rob893.github.io/typescript-extended-linq/interfaces/IEnumerable.html#reverse)
+### [reverseImmutable](https://rob893.github.io/typescript-extended-linq/interfaces/IEnumerable.html#reverseImmutable)
 
 Inverts the order of the elements in a sequence.
 

diff --git a/docs/classes/ArrayEnumerable.html b/docs/classes/ArrayEnumerable.html
diff --git a/docs/classes/BasicEnumerable.html b/docs/classes/BasicEnumerable.html
diff --git a/docs/classes/Enumerable.html b/docs/classes/Enumerable.html
diff --git a/docs/classes/Grouping.html b/docs/classes/Grouping.html
diff --git a/docs/classes/LinkedList.html b/docs/classes/LinkedList.html
diff --git a/docs/classes/LinkedListNode.html b/docs/classes/LinkedListNode.html
diff --git a/docs/classes/List.html b/docs/classes/List.html
diff --git a/docs/classes/OrderedEnumerable.html b/docs/classes/OrderedEnumerable.html
diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html
diff --git a/docs/classes/Queue.html b/docs/classes/Queue.html
diff --git a/docs/classes/Stack.html b/docs/classes/Stack.html
diff --git a/docs/interfaces/ICollection.html b/docs/interfaces/ICollection.html
diff --git a/docs/interfaces/IEnumerable.html b/docs/interfaces/IEnumerable.html
diff --git a/docs/interfaces/IEnumerableFactory.html b/docs/interfaces/IEnumerableFactory.html
diff --git a/docs/interfaces/IGrouping.html b/docs/interfaces/IGrouping.html
diff --git a/docs/interfaces/IList.html b/docs/interfaces/IList.html
diff --git a/docs/interfaces/IOrderedEnumerable.html b/docs/interfaces/IOrderedEnumerable.html
diff --git a/docs/modules.html b/docs/modules.html
diff --git a/src/index.ts b/src/index.ts
@@ -21,6 +21,7 @@ export * from './functions/asEnumerable';
 export * from './functions/atLeast';
 export * from './functions/atMost';
 export * from './functions/average';
+export * from './functions/bindLinqToNativeType';
 export * from './functions/chunk';
 export * from './functions/concatenate';
 export * from './functions/contains';