Type definitions

[viewblock]

Type definitions

[balthazar]

This looks good then! Probably just call it types.d.ts and put it at the root of the project so it doesn't get confused with the actual source and the babel build

[balthazar]

Hello Ben, thanks!

I've mixed feelings about JS typings to be honest, but I know some people grew to like it. What would it imply in term of configuration in this repository exactly? I would prefer if we kept it as simple as possible (all the babel thing is already a tad big imho), but is that even possible to separate typings and the repo source?

[bennycode]

It doesn't require much. In order to serve typings together with your module, you just need to do two simple steps.

1. Add an index.d.ts file (with all the type definitions) to the repository
2. Reference the index.d.ts file in your package.json with a types attribute

There is good documentation here: http://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html

And here is a live example (which I did in the past): https://github.com/caiogondim/logdown.js/pull/45/files

[balthazar]

Do you think we should keep this opened as long as everything is not typed for tracking purposes?

[bennycode]

Yes, let's keep it as a reminder. 😃

I can also make a list of the methods which are still missing definitions for tracking purposes.

Reminder to myself

Turn:

import Binance from 'binance-api-node'

const client: any = this.client = Binance({
  apiKey: process.env.BINANCE_API_KEY,
  apiSecret: process.env.BINANCE_API_SECRET,
})

Into:

import Binance, {BinanceClient} from 'binance-api-node'

const client: BinanceClient = this.client = Binance({
  apiKey: process.env.BINANCE_API_KEY,
  apiSecret: process.env.BINANCE_API_SECRET,
})

[balthazar]

Closing as binance-exchange#4. Improvements of typings will be expressed by new issues, thanks for your help @bennyn!

[bennycode]

@balthazar Okay! Looking forward we should consider using tsd-jsdoc. It would give us the ability to automatically generate type definitions from JSDoc comments. 😃