Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TypeScript declarations #336

Closed

Conversation

vsund
Copy link
Contributor

@vsund vsund commented Jan 3, 2018

I added TypeScript declarations to my fork some time ago. I talked with @jackzampolin about this and he said that I should add a PR to create a platform to discuss. Whether we merge this or not, I'd like to kick off a discussion about:

  1. Is this PR the best way to enable TypeScript developers to use blockstack.js?
  2. How do we assure that the types are up to date with the exposed methods?
  3. How do we assure that the types are correct / complete?
  4. A more general one: While collecting these types, I had some hard times on understanding methods and their return types (can give examples if needed). The return types of some methods are quite confusing and personally as a developer I would expect them to be a bit more descriptive and consistent (can give examples if needed). This might be totally out of scope for this PR, but though I'd like to raise this issue somewhere: How should we deal with this code? Should we refactor (rewrite?) these?

Todo

This PR isn't fully complete yet. Things still to do:

cc @larrysalibra @jackzampolin

@CLAassistant
Copy link

CLAassistant commented Jan 3, 2018

CLA assistant check
Thank you for your submission, we really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ vsund
❌ larrysalibra
You have signed the CLA already but the status is still pending? Let us recheck it.

@jackzampolin
Copy link
Contributor

Thanks for the PR @vsund! We will discuss this at the next engineering meeting.

@vsund
Copy link
Contributor Author

vsund commented Jan 13, 2018

Just noticed that I originally branched it of master but then started merging in constantly develop to keep up with newer code 🙈

This shouldn't change anything since we use git flow and master is basically a snapshotted version of develop, but people might have committed into master manually (since my branch off). So I should be simply able to change the branch to raise against to develop (these potential master commits should come in when we merge develop into master next time).

We definitely should double-check this PR.

@vsund vsund changed the base branch from master to develop January 23, 2018 13:52
@vsund
Copy link
Contributor Author

vsund commented Mar 22, 2018

Just for reference, I'm probably going to abandon this in favor of my blockstack.ts fork.
For progress on the port see ntzwrk/blockstack.ts#3.

Going to close this, can reopen if needed.

@vsund vsund closed this Mar 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants