Consideration for deprecating 'NetworkItem' interface

Moonlight-io / asteroid-sdk-js

5 stars 3 forks source link

Consideration for deprecating 'NetworkItem' interface #40

Closed rockacola closed 4 years ago

rockacola commented 4 years ago

[discussion ticket]

Consideration for removing custom defined NetworkItem interface, as it is a dumbed down version of neonCore.rpc.Network interface.

Pro:

Remove ambiguity
No need for type translation between the 2

Con:

neonCore.rpc.Network interface definition can be a tricker to understand

lllwvlvwlll commented 4 years ago

I think it makes sense to use the explicit one since the network object is a direct pass-through to neon-js. We could consider aliasing NetworkItem => neonCore.rpc.Network to support future differentiation?

rockacola commented 4 years ago

Roll the consideration forward to future release.

rockacola commented 4 years ago

Won't do, consider explicit interface out-weights benefits of combining with neonCore.rpc.Network, especially for short term future.