Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomi/fromfrom
A JS library written in TS to transform sequences of data from format to another
https://github.com/tomi/fromfrom
collection linq sequence transform typescript
Last synced: 4 months ago
JSON representation
A JS library written in TS to transform sequences of data from format to another
- Host: GitHub
- URL: https://github.com/tomi/fromfrom
- Owner: tomi
- License: mit
- Created: 2019-01-14T20:53:10.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T03:16:34.000Z (almost 2 years ago)
- Last Synced: 2024-09-26T07:49:14.588Z (5 months ago)
- Topics: collection, linq, sequence, transform, typescript
- Language: TypeScript
- Homepage:
- Size: 12.3 MB
- Stars: 480
- Watchers: 5
- Forks: 9
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
- awesome-github-repos - tomi/fromfrom - A JS library written in TS to transform sequences of data from format to another (TypeScript)
README
# fromfrom
[](https://greenkeeper.io/)
[](https://travis-ci.com/tomi/fromfrom)
[](https://coveralls.io/github/tomi/fromfrom)
[](https://david-dm.org/tomi/fromfrom?type=dev)
[](http://spiceprogram.org/oss-sponsorship)
[](#contributors)
fromfrom is a [LINQ](https://en.wikipedia.org/wiki/Language_Integrated_Query) inspired library to transform sequences of data.
## Installation
```bash
npm install --save fromfrom
```
## Documentation
Find it [here](https://tomi.github.io/fromfrom/).
## Usage
The library exports only a single function, [`from`](https://tomi.github.io/fromfrom/api/index.html#from). [`from`](https://tomi.github.io/fromfrom/api/index.html#from) wraps the given source data into a [`Sequence`](https://tomi.github.io/fromfrom/api/classes/sequence.html). [`Sequence`](https://tomi.github.io/fromfrom/api/classes/sequence.html) has a wide range of chainable methods to operate and transform the sequence. The sequence can then be converted into a JS type.
For example
```ts
import { from } from "fromfrom";
// Transform an array of users
const users = [
{ id: 1, name: "John", age: 31, active: true },
{ id: 2, name: "Jane", age: 32, active: false },
{ id: 3, name: "Luke", age: 33, active: false },
{ id: 4, name: "Mary", age: 34, active: true },
];
from(users)
.filter(user => user.active)
.sortByDescending(user => user.age)
.toArray();
// Returns
// [
// { id: 4, name: "Mary", age: 34, active: true },
// { id: 1, name: "John", age: 31, active: true }
// ]
```
## Features
- **Familiar method names** - Even though it's LINQ inspired, uses familiar method names from JS.
- **Supports all main JS types** - Works with arrays, objects, maps, sets, and objects that implement the [iterable protocol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
- **No dependencies** - Guarantees small size.
- **Type safe** - Written in TypeScript. Type definitions included.
- **Deferred execution** - The execution of the sequence is deferred until you begin consuming the sequence.
- **Fully tested** - 100% test coverage.
## How does it work
See "how does it work" section from the initial [release blog post](https://github.com/tomi/fromfrom/wiki/Announcing-fromfrom#how-does-it-work).
## Development
### NPM scripts
- `npm t`: Run test suite
- `npm start`: Run `npm run build` in watch mode
- `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `npm run test:prod`: Run linting and generate coverage
- `npm run build`: Generate bundles and typings, create docs
- `npm run lint`: Lints code
- `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)
## Acknowledgement
Made with :heart: by [@TomiTurtiainen](https://twitter.com/TomiTurtiainen).
This project is a grateful recipient of the [Futurice Open Source sponsorship program](https://spiceprogram.org). :heart:
Forked from [TypeScript library starter](https://github.com/alexjoverm/typescript-library-starter)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Tomi Turtiainen
💻 📖 🚇 ⚠️
jtenner
💻 ⚠️ 📖
Ville Vaarala
🚧
Theo
💻
Rudolf Poels
📖
Andrew Ross
🐛
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!