https://github.com/edin-m/node-deliedit

Node js delimited text editing library.
https://github.com/edin-m/node-deliedit

delimiter javascript passthrough

Last synced: 2 months ago
JSON representation

Node js delimited text editing library.

• Host: GitHub
• URL: https://github.com/edin-m/node-deliedit
• Owner: edin-m
• License: isc
• Created: 2015-02-26T10:25:51.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-08-12T00:49:04.000Z (almost 8 years ago)
• Last Synced: 2024-10-19T03:24:43.721Z (8 months ago)
• Topics: delimiter, javascript, passthrough
• Language: JavaScript
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-deliedit

Node js delimited text editing library.

[![npm version](https://badge.fury.io/js/deliedit.svg)](https://badge.fury.io/js/deliedit)

[![Build Status](https://travis-ci.org/edin-m/node-deliedit.svg?branch=master)](https://travis-ci.org/edin-m/node-deliedit)

Node js library for editing stream of text based on delimiters.

For example: 

```

...

...

    before delimiter

    

    in delimiter

    

    after delimiter

...

```

with:

```

var Deliedit = require('deliedit').Deliedit;

var uppercase = function(char) { return char.toUpperCase(); };

var deliedit = new Deliedit({

  delimiters: {

    start: '',

    end: ''

  },

  invert: false,

  withDelimiters: true,

  transformFunc: uppercase

});

fs.createReadStream('in.html').pipe(deliedit).pipe(process.stdout);

```

results in:

```

...

...

    before delimiter

    

    IN DELIMITER

    

    after delimiter

...

```

Options

===

```

var deliedit = new Delimiter(opts);

```

where:

- *opts.delimiter.start* - start delimiter

- *opts.delimiter.end* - end delimiter

- *opts.invert* - apply transformation function to inside delimiter (if false) or outside delimiter (if true)

- *opts.withDelimiters* - include delimiters themselves in output

- *opts.transformFunc* - transformation function: passthrough, ignorechar, uppercase available - defaults to passthrough

- *opts.transform* - DEPRECATED

TODO

===

 - Add support for some other internal transformations

   eg.  html comment / uncomment

        js comment / uncomment