62
edits
Changes
Created page with '== Rationale == For Streams, we need encodings support. There also should be a low-level API available for this. There is some discussion on the mailing list (see <http://group...'
== Rationale ==
For Streams, we need encodings support. There also should be a low-level API available for this.
There is some discussion on the mailing list (see <http://groups.google.com/group/serverjs/browse_thread/thread/6365b2a54615a134>) and here, there is a summary of these efforts.
== Encodings Names ==
Currently proposed are:
* http://www.iana.org/assignments/character-sets
* ICONV character set names
== API ==
OK, so probably this should be a module:
var enc = require('encodings')
For convenience, there should be these easy methods for converting between encodings:
string = enc.convertToString(sourceEncoding, byteStringOrArray)
byteString = enc.convertFromString(targetEncoding, string)
byteString = enc.convert(sourceEncoding, targetEncoding, byteStringOrArray)
=== Class: Converter ===
There also should be a class enc.Converter for more advanced conversion.
; [Constructor] Converter(from, to)
: Where from and to are the encoding names.
; [Method] push(byteStringOrArray)
: Convert input from a ByteString or ByteArray. The results are stored in an internal buffer, and also those parts of byteStringOrArray that could not be converted (for multi-byte encodings, in a separate buffer).
: Returns nothing.
; [Method] get([byteArray,] [maximumSize])
: Read maximumSize bytes or as many bytes as available out of the internal buffer. If byteArray is specified, the data is written into that ByteArray.
: Returns a ByteString if byteArray is not specified, or byteArray itself otherwise.
Example usage:
Converter = require('encodings').Converter
converter = new Converter('iso-8859-1', 'utf-32')
converter.push(input)
output = converter.get()
For Streams, we need encodings support. There also should be a low-level API available for this.
There is some discussion on the mailing list (see <http://groups.google.com/group/serverjs/browse_thread/thread/6365b2a54615a134>) and here, there is a summary of these efforts.
== Encodings Names ==
Currently proposed are:
* http://www.iana.org/assignments/character-sets
* ICONV character set names
== API ==
OK, so probably this should be a module:
var enc = require('encodings')
For convenience, there should be these easy methods for converting between encodings:
string = enc.convertToString(sourceEncoding, byteStringOrArray)
byteString = enc.convertFromString(targetEncoding, string)
byteString = enc.convert(sourceEncoding, targetEncoding, byteStringOrArray)
=== Class: Converter ===
There also should be a class enc.Converter for more advanced conversion.
; [Constructor] Converter(from, to)
: Where from and to are the encoding names.
; [Method] push(byteStringOrArray)
: Convert input from a ByteString or ByteArray. The results are stored in an internal buffer, and also those parts of byteStringOrArray that could not be converted (for multi-byte encodings, in a separate buffer).
: Returns nothing.
; [Method] get([byteArray,] [maximumSize])
: Read maximumSize bytes or as many bytes as available out of the internal buffer. If byteArray is specified, the data is written into that ByteArray.
: Returns a ByteString if byteArray is not specified, or byteArray itself otherwise.
Example usage:
Converter = require('encodings').Converter
converter = new Converter('iso-8859-1', 'utf-32')
converter.push(input)
output = converter.get()
