Skip to content

dibiancoj/Linq4Javascript

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Description

JLinq.ts(.js) is an implementation of .Net's Linq To Objects. It is built using iterators for complete lazy evaluation to reduce memory and improve performance.

Why I Built This Library

I wanted to learn TypeScript along with building a linq library which had method names and syntax much like the .Net version. I love underscore but I always had to lookup the method name I was looking for.

Features
  • Implement's .Net Linq methods with the same syntax
  • Complete lazy evaluation to reduce memory footprint while improving performance
  • You can use the Typescript file for type safety or use the .js version for plain old Javascript.
  • Contains async functionality to offload work off of the UI thread. Prevents freezing on long running methods.
  • Drastically outperforms Underscore.js in Chrome, Firefox, and Safari

Setup

  • Import the JLinq.js file into your html page. Or bring JLinq.ts into solution if you are using TypeScript. These files are located in the following path of the project: 'Linq4Javascript/Scripts'

         <script src="/Scripts/JLinq.js"></script>
    
  • For Node.js just use a require statement. This will allow access to the extension methods off of the array. Every array will have access to the methods of Linq4Javascript. JLinq is the file name where the Linq4Javascript code is in. If you change the file name then update this. The ./ is set because it is in the root folder of the project.

        var linq = require('./JLinq'); 
    

Basic Example

//declare my array that will represent my data source  
var _Array= [];    

//let's throw some sample data into my array  
for (var i = 0; i < 10; i++)    
{   
   _Array.push({ id: i, txt: i.toString(), subArray: [1,2,3] });    
}  

Let's run a sample where I filter any record where Id > 5. The return value will be a iterator.
var myQuery = _Array.Where(function (x) { return x.id > 5; });

How do I get my results from my query above?

  • Call .ToArray() which will evaluate the results right away and return an array from the where clause
    var results = _Array.Where(function (x) { return x.id > 5; }).ToArray();

  • I could also run though the results 1 at a time. This would reduce memory because we never have to materialize a large array when calling ToArray().

           //Holds the current item of the result set  
           var CurrentResult;
    
           //Checks the query to see if we have any more records that are returned from the query
           while ((CurrentResult = QueryToRun.Next()).CurrentStatus !== ToracTechnologies.JLinq.IteratorStatus.Completed)   
           {    
                 //do something with my result   
                 var myResultItem = CurrentResult.CurrentItem;     
           }
    

View the full documentation at: https://github.com/dibiancoj/Linq4Javascript/wiki

About

JLinq.ts(.js) is an implementation of .Net's Linq To Objects. It is built using iterators for complete lazy evaluation to reduce memory and improve performance.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published