cennznet / api.js

CENNZnet JS API for browsers, React Native and Node.js
Apache License 2.0
10 stars 10 forks source link

Doc generated from typedoc for derive #335

Closed KarishmaBothara closed 3 years ago

KarishmaBothara commented 3 years ago

Used typedoc to generate typescript doc for derive and merged the generated doc with the module..

https://github.com/cennznet/api.js/blob/deriveDocs/docs/cennznet/nft.md https://github.com/cennznet/api.js/blob/deriveDocs/docs/cennznet/cennzx.md https://github.com/cennznet/api.js/blob/deriveDocs/docs/cennznet/staking.md

also add the interface to doc folder so that when user navigates thro' link in the document, it know what interface is used..

KarishmaBothara commented 3 years ago

nice! Small thing, but I noticed that not all the methods have their argument types defined. Is it possible to generate it for them all?

which method did you see this missing for 'derive queries' section?

eupston commented 3 years ago

nice! Small thing, but I noticed that not all the methods have their argument types defined. Is it possible to generate it for them all?

which method did you see this missing for 'derive queries' section?

ahh yup was looking at RPC calls sorry. Derives look all good.

KarishmaBothara commented 3 years ago

looks, like @eupston accidentally closed it..