Add comment about BlockParamLiteral explaining the omission of Earliest

2017-11-23 15:36:46 -06:00
parent cee0d2706f
commit ab78c54d6a
1 changed files with 3 additions and 0 deletions
--- a/packages/0x.js/src/types.ts
+++ b/packages/0x.js/src/types.ts
@@ -351,6 +351,9 @@ export interface IndexedFilterValues {
    [index: string]: ContractEventArg;
 }

+// Earliest is omitted by design. It is simply an alias for the `0` constant and
+// is thus not very helpful. Moreover, this type is used in places that only accept
+// `latest` or `pending`.
 export enum BlockParamLiteral {
    Latest = 'latest',
    Pending = 'pending',