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 definition #127

Closed
sindresorhus opened this issue Jan 12, 2021 · 5 comments · Fixed by #138
Closed

Add TypeScript definition #127

sindresorhus opened this issue Jan 12, 2021 · 5 comments · Fixed by #138

Comments

@sindresorhus
Copy link
Owner

If anyone wants to contribute, keep this in mind:

@jopemachine
Copy link
Contributor

jopemachine commented Jul 22, 2021

May I ask if I could take on this?

Here is my draft though I'm not sure all the interface names are enough intuitive.

I'd appreciate it if you could check and tell me if there's anything lacking.

Note:

  • The descriptions of attributes of ScriptFilterItem are be copied from JSON script filter format, and the other comments were copied from alfy READMD.

  • Since there is no type declarations in the cache-conf, I also typed it in here though I'm not sure this type should be here.

  • I've excluded action attritube from ScriptFilterItem because it is not implemented in Alfred yet. (According to this page, it is going to be introduced in Alfred 4.5)

I appreciate for always providing and maintaining lots of awesome libraries.

@sindresorhus
Copy link
Owner Author

May I ask if I could take on this?

Sure, do a pull request. It's easier to give feedback directly then.

@sindresorhus
Copy link
Owner Author

Since there is no type declarations in the cache-conf, I also typed it in here though I'm not sure this type should be here.

Maybe do a pull request to add types to that package? Link to it here and I'll ping the maintainer to review it.

@sindresorhus
Copy link
Owner Author

I've excluded action attritube from ScriptFilterItem because it is not implemented in Alfred yet. (According to this page, it is going to be introduced in Alfred 4.5)

Add it commented out with a todo comment to enable it when Alfred 4.5 is out.

@jopemachine
Copy link
Contributor

jopemachine commented Jul 22, 2021

Thanks, I made a PR in here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants