Filepond: Create typescript typing

[hgenru]

Typescript typings can help new users with your awesome library. Typing used in VSCode for IntelliSense for all javascript projects. Also, typescript is a very popular choice in the angular community.

Do you have plans about this?

I will create a simple typing for filepond because in my team typings is required. Or, if you have groundwork I can help with it.

[rikschennink]

I’ve got literally zero experience with typescript so I’m open to suggestions and pull requests. :)

[hgenru]

Hello @rikschennink! Sorry about long time response. I had too many works.

There is draft typing for FIlePond: https://gist.github.com/hgenru/7a7aa4af2dc0e9e704777655e9182cc8

If we consider using your library in our project I will update this typing and, maybe, create a PR.

[hgenru]

The bigger problem is plugins options in the main options object. Currently, I have no idea how to extend options with plugins options only when a plugin is connected.

But it not only typing problem btw.

[hgenru]

Also, there are conditional requirements. Some options required only when no options specified. In typescript world, this problem can be solved with the interface overloading. But it complicated and I do not really understand what required and when for some parts of your API.

[rikschennink]

I ran into similar problems with Angular. I don't know how to solve this. I would eventually like if everyone can write plugins, I see that might cause trouble with things like TypeScript?

[hgenru]

I think the better solution is to create plugin API and move all plugin specific options into a plugin instance. But it's a really big design challenge.

Another way is to bundle all your plugins into one component, but allow custom builds. Like swiper custom build.

[rikschennink]

Thanks, I'll look into that when I have some time, it's currently not one of my top priorities, to be honest.

[Hawxy]

@rikschennink Is this going to be worked on at some point? It's kinda a pain point as more and more people are using TS to write front-ends. The only typing's available for FP right now are for the react wrapper, which could be used as a base for official typings

[rikschennink]

@Hawxy I've gained some more experience with TS while added a TypeScript definition file to Doka. It's simply a time consuming process of converting the options definition file and the public API to a .d.ts file, if you're experienced with TypeScript and are in need of this feature, please submit a PR, I'll get around to it eventually.