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

TypeScript support #905

Closed
gdethier opened this issue Aug 10, 2021 · 5 comments
Closed

TypeScript support #905

gdethier opened this issue Aug 10, 2021 · 5 comments

Comments

@gdethier
Copy link

Currently, one wanting to use orbit-db's API in a TypeScript project must provide type definitions (him/her)self. It would be nice to be able to install type definitions with yarn add --dev @types/orbit-db or something the like.

@chrispanag
Copy link

There is semi-official type support here:

https://github.com/orbitdb/orbit-db-types

Just add "@types/orbit-db": "https://github.com/orbitdb/orbit-db-types.git" to your package.json

@gdethier
Copy link
Author

Great, thanks for the link @chrispanag ! I guess the issue should remain open until type support becomes official, right?

@chrispanag
Copy link

You are welcome @gdethier!

I guess the issue should remain open until type support becomes official, right?

This is up to the maintainers. Adding typings to OrbitDB was also mentioned on the Road to v1.0 Thread.

@arseniy-gl
Copy link

I propose going to typescript.

My first step in project orbit-db-io

@haydenyoung
Copy link
Member

Currently there are no plans to migrate OrbitDB to TS. However, there are contributions being proposed which provide type defs.

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

No branches or pull requests

4 participants