From af63934d2ca0d2830a8609c16bd685a02241e257 Mon Sep 17 00:00:00 2001
From: Steve Klebanoff <steve.klebanoff@gmail.com>
Date: Tue, 15 Jan 2019 13:57:31 -0800
Subject: Export types and add additional documentation

---
 packages/asset-buyer/src/index.ts | 4 ++++
 packages/asset-buyer/src/types.ts | 6 ++++++
 2 files changed, 10 insertions(+)

(limited to 'packages/asset-buyer')

diff --git a/packages/asset-buyer/src/index.ts b/packages/asset-buyer/src/index.ts
index a42d7e272..339d64616 100644
--- a/packages/asset-buyer/src/index.ts
+++ b/packages/asset-buyer/src/index.ts
@@ -1,3 +1,4 @@
+import { LiquidityRequestOpts } from './../lib/src/types.d';
 export {
     JSONRPCRequestPayload,
     JSONRPCResponsePayload,
@@ -19,6 +20,9 @@ export {
     BuyQuoteExecutionOpts,
     BuyQuoteInfo,
     BuyQuoteRequestOpts,
+    LiquidityForAssetData,
+    LiquidityRequestOpts,
+    OrdersAndFillableAmounts,
     OrderProvider,
     OrderProviderRequest,
     OrderProviderResponse,
diff --git a/packages/asset-buyer/src/types.ts b/packages/asset-buyer/src/types.ts
index da8b75c8f..0bf2323bd 100644
--- a/packages/asset-buyer/src/types.ts
+++ b/packages/asset-buyer/src/types.ts
@@ -76,6 +76,8 @@ export interface BuyQuoteRequestOpts {
 }
 
 /*
+ * Options for checking liquidity
+ *
  * shouldForceOrderRefresh: If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. Defaults to false.
  */
 export interface LiquidityRequestOpts extends Pick<BuyQuoteRequestOpts, 'shouldForceOrderRefresh'> {}
@@ -122,6 +124,10 @@ export enum AssetBuyerError {
     TransactionValueTooLow = 'TRANSACTION_VALUE_TOO_LOW',
 }
 
+/**
+ * orders: An array of signed orders
+ * remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed orders. The index of an item in the array associates the amount with the corresponding order.
+ */
 export interface OrdersAndFillableAmounts {
     orders: SignedOrder[];
     remainingFillableMakerAssetAmounts: BigNumber[];
-- 
cgit