more documentation

2018-12-14 17:05:52 -08:00
parent 2e2e157fc8
commit aa9aa1f58a
1 changed files with 6 additions and 0 deletions
--- a/packages/asset-buyer/src/errors.ts
+++ b/packages/asset-buyer/src/errors.ts
@@ -6,7 +6,13 @@ import { AssetBuyerError } from './types';
 * Error class representing insufficient asset liquidity
 */
 export class InsufficientAssetLiquidityError extends Error {
+    /**
+     * The amount availabe to fill (in base units) factoring in slippage.
+     */
    public amountAvailableToFill?: BigNumber;
+    /**
+     * @param amountAvailableToFill The amount availabe to fill (in base units) factoring in slippage
+     */
    constructor(amountAvailableToFill?: BigNumber) {
        super(AssetBuyerError.InsufficientAssetLiquidity);
        this.amountAvailableToFill = amountAvailableToFill;