Merge pull request #924 from 0xProject/wrap-typedoc

Improved Docs & Removed monorepo-scripts from packages

1 files changed, 15 insertions, 0 deletions

diff --git a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts
index 865ea4e43..fbc1c4718 100644
--- a/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts
+++ b/packages/order-utils/src/abstract/abstract_order_filled_cancelled_fetcher.ts
@@ -1,7 +1,22 @@
 import { BigNumber } from '@0xproject/utils';
 
+/**
+ * An abstract class to be implemented in order to use OrderStateUtils. The class that
+ * implements this interface must be capable of fetching the amount filled of an order
+ * and whether it's been cancelled.
+ */
 export abstract class AbstractOrderFilledCancelledFetcher {
+    /**
+     * Get the amount of the order's takerToken amount already filled
+     * @param orderHash OrderHash of order we are interested in
+     * @return FilledTakerAmount
+     */
     public abstract async getFilledTakerAmountAsync(orderHash: string): Promise<BigNumber>;
+    /**
+     * Whether an order is cancelled
+     * @param orderHash OrderHash of order we are interested in
+     * @return Whether or not the order is cancelled
+     */
     public abstract async isOrderCancelledAsync(orderHash: string): Promise<boolean>;
     public abstract getZRXAssetData(): string;
 }