From ab78c54d6a6e8592c43b779b651cc7203de2e66e Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Thu, 23 Nov 2017 15:36:46 -0600 Subject: Add comment about BlockParamLiteral explaining the omission of Earliest --- packages/0x.js/src/types.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/0x.js/src/types.ts b/packages/0x.js/src/types.ts index 7d85a54ca..143e2b6b2 100644 --- 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', -- cgit v1.2.3