base64-stream - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

index.js

		@@ -0,4 +1,9 @@
		var Base64Encode = require('./lib/encode');
		var Base64Decode = require('./lib/decode');

		module.exports = {
		Encode : require('./lib/encode.js'),
		Decode : require('./lib/decode.js')
		Encode : Base64Encode,
		encode : Base64Encode,
		Decode : Base64Decode,
		decode : Base64Decode
		};

package.json

		@@ -6,3 +6,3 @@ {
		"author" : "Ross Johnson <ross@mazira.com>",
		"version" : "0.1.1",
		"version" : "0.1.2",
		"repository" : {
		@@ -9,0 +9,0 @@ "type" : "git",

README.md

		@@ -7,37 +7,41 @@ # Introduction

		# Installation
		# Usage

		## Installation

		To install base64-stream

		npm install base64-stream

		## Examples
		This example encodes an image and pipes it to stdout.

		# Requirements
		```javascript
		var http = require('http');
		var base64 = require('base64-stream');

		This module currently requires Node v0.8 or higher. Support for versions prior to v0.10 is made possible by using the [readable-stream](https://github.com/isaacs/readable-stream) module.
		var img = 'http://farm3.staticflickr.com/2433/3973241798_86ddfa642b_o.jpg';
		http.get(img, function(res) {
		if (res.statusCode === 200)
		res.pipe(base64.encode()).pipe(process.stdout);
		});
		```

		# Usage
		This example takes in Base64 encoded data on stdin, decodes it, an pipes it to stdout.
		```javascript
		var base64 = require('base64-stream');
		process.stdin.pipe(base64.decode()).pipe(process.stdout);
		```

		To use base64-stream

		You may also treat `encode` / `decode` as classes, so the following is also valid:
		```javascript
		var fs = require('fs');
		var Base64Encode = require('base64-stream').Encode;
		var Base64Decode = require('base64-stream').Decode;
		var Base64Decode = require('base64-stream').decode;
		var stream = new Base64Decode();
		...
		```

		var streamMailAttachment = function(req, res, next) {
		var getAttachment(...);
		attachmentStream.pipe(new Base64Encode()).pipe(res);
		# Requirements

		// would also work
		// attachmentStream.pipe(Base64Encode()).pipe(res);
		}
		This module currently requires Node v0.8 or higher. Support for versions prior to v0.10 is made possible by using the [readable-stream](https://github.com/isaacs/readable-stream) module.

		var uploadAttachment = function(req, res, next) {
		var email = createEmail(...);

		var stream = req.pipe(new Base64Encode());
		email.streamAttachment(stream);
		}
		```

		# Testing
		@@ -48,1 +52,4 @@
		npm test

		# License
		MIT

base64-stream - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics