https://github.com/sidneyarcidiacono/data-parser

A node module designed to make reading in large files as easy as calling one function.
https://github.com/sidneyarcidiacono/data-parser

data javascript node npm

Last synced: about 2 months ago
JSON representation

A node module designed to make reading in large files as easy as calling one function.

• Host: GitHub
• URL: https://github.com/sidneyarcidiacono/data-parser
• Owner: sidneyarcidiacono
• Created: 2021-05-05T21:16:23.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2021-05-05T21:37:41.000Z (about 5 years ago)
• Last Synced: 2025-02-14T04:47:55.790Z (over 1 year ago)
• Topics: data, javascript, node, npm
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@sidarcidiacono/dataparser
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# 📑 DataParser

[![NPM version](https://img.shields.io/npm/v/@sidarcidiacono/dataparser.svg?style=flat)](https://www.npmjs.com/package/@sidarcidiacono/dataparser) [![NPM downloads](https://img.shields.io/npm/dm/@sidarcidiacono/dataparser.svg?style=flat)](https://npmjs.org/package/@sidarcidiacono/dataparser) [![Build Status](https://img.shields.io/travis/sidarcidiacono/@sidarcidiacono/dataparser.svg?style=flat)](https://travis-ci.org/sidarcidiacono/@sidarcidiacono/dataparser)

An npm module that streams your data for you.

## Features

- Efficiently create a data stream by calling a single function.

- Let DataParser do all the heavy lifting!

## Installation

Install locally for any project:

```zsh

npm install @sidarcidiacono/dataparser --save

```

*Note: --save is the default behavior, and is provided simply for clarity.*

## Usage

DataParser provides the streamData method. To get started, you can require it:

```javascript

const { streamData } = require('dataparser')

```

Then, you just need to provide your:

- filePath as a string

- mode

Example:

```javascript

data = streamData('/path/to/data.txt', 'utf8')

```

And you're done! That's all there is to it!