Custom connectors and additional typings

[imatlopez]

Made the SentinelIterator and actual Iterator and made it not affect this.options.sentinels in place (tests were there to test the side effect).

Added floatingSentinels to the SentinelConnectorOptions which is called whenever connect is called, it must return an array of sentinels using a callback.

Welcome any feedback :)

resolves #903 for Sentinel at least :)

[luin]

Thanks for the pull request!

It adds some overheads to add an option for this specified issue. A better way seems to be customizing SentinelConnector by overriding SentinelConnector#connect() to fetch dynamic endpoints first.

Currently, it could be a little bit hacky since there's no way for users to provide customized connectors to Redis. But it trivial to add an option to Redis like connector which will solve a broader set of problems.

[imatlopez]

I added the connector property to the config, which is now where Redis uses its connector from. Hence if no property is set, the constructor will assign it based on the old behavior.

I reverted some of the changes to SentinelConnector but not all because I felt it is cleaner this way (?)

Added AsyncSentinelConnector as an example of a custom connector that can be passed in.

Modified index.ts to export some types (and make the module interoperable with es6 modules), so once typings are satisfactory, it's just a mater of exporting the types.

[imatlopez]

@luin let me know your thoughts :)

[luin]

Awesome work! As you said, that changes made on SentinelConnector make the code cleaner. The most parts of codes are great, and I've left some comments about the interface of SentinelConnector since this the first time we export it.

[luin]

I suggest moving this file to the examples folder since most users don't need it, and it trivial to implement one. What do you think?

[imatlopez]

👍 now I just need to find why the tests fail

[luin]

Why npm run build is needed here?

[imatlopez]

test may have type errors like trying to access private properties, but the code itself is fine, so this guards against build time errors while the tests are for logical errors only.

[imatlopez]

I think I dug myself a deep hole trying to change the interface to promises. I haven't figured out how to run the tests locally either so I'm gonna need some assistance 😁

edit: scratch that... just went too far with the cleanup

[imatlopez]

@luin I've noticed that the ESLint doesn't quite run in some parts of the code, fixing it by adding typescript-eslint added lots of conflicts. Once this goes in, would you like another PR adding it for code consistency? I personally like Prettier for code styling too.

[luin]

@imatlopez That would be great! And Prettier is also my favorite :-)

[ioredis-robot]

🎉 This PR is included in version 4.11.0 🎉

The release is available on:

• npm package (@next dist-tag)
• GitHub release

Your semantic-release bot 📦🚀