Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shannonmoeller/hunk
Multipart files, one hunk at a time.
https://github.com/shannonmoeller/hunk
Last synced: 18 days ago
JSON representation
Multipart files, one hunk at a time.
- Host: GitHub
- URL: https://github.com/shannonmoeller/hunk
- Owner: shannonmoeller
- License: mit
- Created: 2013-08-09T14:33:02.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2018-01-20T23:07:22.000Z (almost 7 years ago)
- Last Synced: 2024-10-20T03:31:25.455Z (24 days ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# hunk
[](http://travis-ci.org/shannonmoeller/hunk)
Multipart files, one hunk at a time.
## Getting Started
Install the module with: `npm install hunk`
## Documentation
### `hunk( String ) : Array|Object`
Accepts a string representing multiple documents, delimited by triple hypens (`---`), just like YAML. Delimiters may be named by appending any text you want after the hypens (`---foo`), unlike YAML.
## Examples
### Usage
```javascript
var fs = require('fs');
var hunk = require('hunk');
fs.readFile('foo.hnk', 'utf8', function (err, data) {
console.log(hunk(data));
});
```
### Array
#### Input (`foo.hnk`):
```
---
hello world
---
foo
---
bar
---
```
#### Output:
```javascript
['hello world', 'foo', 'bar']
```
### Object
#### Input (`foo.hnk`):
```
---hello
world
---foo
bar
---
baz
---
```
#### Output:
```javascript
{
hello: 'world',
foo: 'bar',
2: 'baz'
}
```
## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
## Release History
- 1.0.5: Better handling of whitespace.
----
MIT © [Shannon Moeller](http://shannonmoeller.com)