Merge pull request #59 from webmaster128/rlp-type

Export types used by decode/encode

src/index.ts

@@ -1,14 +1,17 @@
 import BN = require('bn.js')
 
-import { RLPInput, RLPDecoded } from './types'
+import { Decoded, Dictionary, Input, List } from './types'
+
+// Types exported outside of this package
+export { Decoded, Dictionary, Input, List }
 
 /**
  * RLP Encoding based on: https://github.com/ethereum/wiki/wiki/%5BEnglish%5D-RLP
  * This function takes in a data, convert it to buffer if not, and a length for recursion
  * @param input - will be converted to buffer
  * @returns returns buffer of encoded data
  **/
-export function encode(input: RLPInput): Buffer {
+export function encode(input: Input): Buffer {
   if (input instanceof Array) {
     const output: Buffer[] = []
     for (let i = 0; i < input.length; i++) {
@@ -56,8 +59,8 @@ function encodeLength(len: number, offset: number): Buffer {
  **/
 export function decode(input: Buffer, stream?: boolean): Buffer
 export function decode(input: Buffer[], stream?: boolean): Buffer[]
-export function decode(input: RLPInput, stream?: boolean): Buffer[] | Buffer | RLPDecoded
-export function decode(input: RLPInput, stream: boolean = false): Buffer[] | Buffer | RLPDecoded {
+export function decode(input: Input, stream?: boolean): Buffer[] | Buffer | Decoded
+export function decode(input: Input, stream: boolean = false): Buffer[] | Buffer | Decoded {
   if (!input || (<any>input).length === 0) {
     return Buffer.from([])
   }
@@ -80,7 +83,7 @@ export function decode(input: RLPInput, stream: boolean = false): Buffer[] | Buf
  * @param input
  * @returns The length of the input or an empty Buffer if no input
  */
-export function getLength(input: RLPInput): Buffer | number {
+export function getLength(input: Input): Buffer | number {
   if (!input || (<any>input).length === 0) {
     return Buffer.from([])
   }
@@ -106,7 +109,7 @@ export function getLength(input: RLPInput): Buffer | number {
 }
 
 /** Decode an input with RLP */
-function _decode(input: Buffer): RLPDecoded {
+function _decode(input: Buffer): Decoded {
   let length, llength, data, innerRemainder, d
   const decoded = []
   const firstByte = input[0]
@@ -220,7 +223,7 @@ function intToBuffer(integer: number): Buffer {
 }
 
 /** Transform anything into a Buffer */
-function toBuffer(v: RLPInput): Buffer {
+function toBuffer(v: Input): Buffer {
   if (!Buffer.isBuffer(v)) {
     if (typeof v === 'string') {
       if (isHexPrefixed(v)) {

src/types.ts

@@ -1,13 +1,16 @@
 import BN = require('bn.js')
 
-export type RLPInput = Buffer | string | number | Uint8Array | BN | RLPObject | RLPArray | null
+export type Input = Buffer | string | number | Uint8Array | BN | Dictionary | List | null
 
-export interface RLPArray extends Array<RLPInput> {}
-interface RLPObject {
-  [x: string]: RLPInput
+// Use interface extension instead of type alias to
+// make circular declaration possible.
+export interface List extends Array<Input> {}
+
+export interface Dictionary {
+  [x: string]: Input
 }
 
-export interface RLPDecoded {
+export interface Decoded {
   data: Buffer | Buffer[]
   remainder: Buffer
 }