059d3d0d by brandonocasey

added file-level comments to files

1 parent 63c80f63
/**
* This file contains the `Decrypter` class which manages
* AES decryption through the `decrypt` function (which uses
* the `AES` class for lower level decrypting) and Asynchronous
* Streams from the `AsyncStream` class
*/
import AES from './aes';
import AsyncStream from './async-stream';
import {unpad} from 'pkcs7';
......@@ -95,6 +102,11 @@ export const decrypt = function(encrypted, key, initVector) {
return decrypted;
};
/**
* The `Decrypter` class that manages decryption of AES
* data through `AsyncStream` objects and the `decrypt`
* function
*/
export class Decrypter {
constructor(encrypted, key, initVector, done) {
let step = Decrypter.STEP;
......
/**
* Main file for Decrypter so that we can neatly export
* all of our functionality as one object in one file
* and we will only have to require the top level directory
* in this case that would look like:
* ``` JavaScript
* import {Decrypter, decrypt, AsyncStream} from './src/decrypter';
* ```
*/
import {decrypt, Decrypter} from './decrypter';
import AsyncStream from './async-stream';
......