aboutsummaryrefslogtreecommitdiffstats
path: root/packages/order-watcher
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-04 04:24:42 +0800
committerFabio Berger <me@fabioberger.com>2018-08-04 04:24:42 +0800
commit30be039570d6a533a339c47d068e3d4ef0f4c92a (patch)
tree2315a17af19a3fd82e35907ad3bd434583dec5cd /packages/order-watcher
parentbcc1ad20869d10fb16678619e6fa411e53a07742 (diff)
downloaddexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.tar
dexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.tar.gz
dexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.tar.bz2
dexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.tar.lz
dexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.tar.xz
dexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.tar.zst
dexon-sol-tools-30be039570d6a533a339c47d068e3d4ef0f4c92a.zip
Add missing comments
Diffstat (limited to 'packages/order-watcher')
-rw-r--r--packages/order-watcher/src/order_watcher/order_watcher.ts6
1 files changed, 6 insertions, 0 deletions
diff --git a/packages/order-watcher/src/order_watcher/order_watcher.ts b/packages/order-watcher/src/order_watcher/order_watcher.ts
index e2d6fc270..d4c5cca4b 100644
--- a/packages/order-watcher/src/order_watcher/order_watcher.ts
+++ b/packages/order-watcher/src/order_watcher/order_watcher.ts
@@ -87,6 +87,12 @@ export class OrderWatcher {
private readonly _cleanupJobInterval: number;
private _cleanupJobIntervalIdIfExists?: NodeJS.Timer;
private _callbackIfExists?: OnOrderStateChangeCallback;
+ /**
+ * Instantiate a new OrderWatcher
+ * @param provider Web3 provider to use for JSON RPC calls
+ * @param networkId NetworkId to watch orders on
+ * @param partialConfig Optional configurations
+ */
constructor(
provider: Provider,
networkId: number,