aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonid Logvinov <logvinov.leon@gmail.com>2017-06-15 23:27:21 +0800
committerLeonid Logvinov <logvinov.leon@gmail.com>2017-06-15 23:27:21 +0800
commit209ca3046058e51ffc301737564029de5511967e (patch)
treea129ea78cd334faaa4957cb953ed3532d26ebfa9
parentd789aa24aa2c9f4e0d17a382fe9cb8d56ab27957 (diff)
downloaddexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.tar
dexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.tar.gz
dexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.tar.bz2
dexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.tar.lz
dexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.tar.xz
dexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.tar.zst
dexon-sol-tools-209ca3046058e51ffc301737564029de5511967e.zip
Add explaining comment for the web3Provider type
-rw-r--r--src/types.ts6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/types.ts b/src/types.ts
index 8c9e9ad5d..5be64da53 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -281,5 +281,9 @@ export interface ContractEventEmitter {
watch: (eventCallback: EventCallback) => void;
stopWatchingAsync: () => Promise<void>;
}
-
+/**
+ * We re-export the `Web3.Provider` type specified in the Web3 Typescript typings
+ * since it is the type of the `provider` argument to the `ZeroEx` constructor.
+ * It is however a `Web3` library type, not a native `0x.js` type.
+ */
export type Web3Provider = Web3.Provider;