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

IFlags is not included as an import in Command examples #44

Closed
njpearman opened this issue Jul 1, 2020 · 3 comments
Closed

IFlags is not included as an import in Command examples #44

njpearman opened this issue Jul 1, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation module:command command module

Comments

@njpearman
Copy link

Hi!

First, thanks for the work on this library. I'm new to Deno and TypeScript but have found the API for this lib intuitive as it's similar to command suite libs I've used in other languages.

I got a bit stuck when I implemented an action handler though, as I wasn't sure where to find the IFlags type. I got to it eventually from looking through the codebase but it might be helpful to mention where to find or include that dependency in the examples and docs.

@c4spar
Copy link
Owner

c4spar commented Jul 1, 2020

Hi @njpearman,

thx for the issue!
You're right. the types are not optimal yet. i'm working on this atm.

@c4spar c4spar self-assigned this Jul 2, 2020
@c4spar c4spar added documentation Improvements or additions to documentation module:command command module labels Jul 2, 2020
@c4spar c4spar added this to To do in Cliffy v1.0.0 via automation Jul 2, 2020
@c4spar c4spar moved this from To do to In progress in Cliffy v1.0.0 Jul 2, 2020
@c4spar
Copy link
Owner

c4spar commented Jul 2, 2020

Hi @njpearman,

i have updated the documentation. You don't need to use the IFlags type, it was wrong in the documentation. You can simply use the any type. There are no types for the options object atm.

@c4spar c4spar moved this from In progress to Done in Cliffy v1.0.0 Jul 2, 2020
@c4spar c4spar closed this as completed Jul 2, 2020
@njpearman
Copy link
Author

Great, I'll take a look. Sorry for not acknowledging sooner; I've had a busy few days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation module:command command module
Projects
Cliffy v1.0.0
  
Done
Development

No branches or pull requests

2 participants