Use named parameters for ib.contract.XXX

[tredondo]

The long list of parameters for various contract types is unwieldy, and also inconsistent in the parameter order:

future: symbol, expiry, currency, exchange, multiplier fop: symbol, expiry, strike, right, multiplier, exchange, currency

Using destructured parameters would make calls consistent, and much less error-prone:

ib.contract.future({
  symbol: 'YM',
  expiry: '...',
  multiplier: 5,
  exchange: 'GLOBEX',  // for some reason the default exchange for futures is ONE
});

I'm writing a function that parses strings into contract and it's a long switch statement right now because of the variable parameter order.

[pilwon]

@meteorpublish I agree this change will make writing contracts more flexible and easier to read, however it'll be a breaking change. Any suggestion for introducing this without touching existing API?

[tredondo]

Well, since the package is at v0.x, its API is not really guaranteed per semver anyway. One suggestion would be to release v1, rewritten using ES Modules, and with named parameters.

For v0.3, could ib.contract be overridden to take named parameters, e.g.

ib.contract({ type: 'stock', symbol: 'AAPL' })

Otherwise, methods with an O (for "object") suffix could be used:

ib.contract.fopO({ symbol: 'ES', expiry: '20190920', strike: ..., })

[pilwon]

@meteorpublish Yes, you're right about v0.x. I however still wish to maintain this library that doesn't surprise existing users unless it's absolutely necessary. I prefer the cleaner ib.contract({ ... }) option.

[tredondo]

@pilwon: do you still have time to maintain this library? I've submitted a PR announcing that it needs maintainers.