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

Export Interfaces for docs #49

Closed
tejasag opened this issue Dec 3, 2020 · 7 comments
Closed

Export Interfaces for docs #49

tejasag opened this issue Dec 3, 2020 · 7 comments
Assignees
Labels
bug 🐛 Something isn't working documentation 📔 Improvements or additions to documentation

Comments

@tejasag
Copy link
Contributor

tejasag commented Dec 3, 2020

Many class's constructors have Interfaces as parameters but since the Interface is not exported from mod.ts so they don't appear in the docs..
If someone, who is new to the library, will check the docs then he will go hella confused because we have many of these un-exported interfaces
Like this one class:
image

@AkiaCode AkiaCode added bug 🐛 Something isn't working documentation 📔 Improvements or additions to documentation labels Dec 3, 2020
@DjDeveloperr
Copy link
Member

Those classes aren't meant to be directly constructed by user.

@ghost
Copy link

ghost commented Dec 5, 2020

You cannot construct/instantiate an interface. 😅

@DjDeveloperr
Copy link
Member

DjDeveloperr commented Dec 5, 2020

You cannot construct/instantiate an interface. 😅

I mean classes like GuildIntegration, Message whose constructors need those interfaces ... those are constructed and returned by Managers only.

@Preta-Crowz
Copy link
Contributor

I think they can be used to other advanced things too

@DjDeveloperr
Copy link
Member

True, I don't mind exporting them 👍 and raw event can be used to access the raw payloads of events dispatched.

@tejasag
Copy link
Contributor Author

tejasag commented Dec 25, 2020

If this is done then i think we can close this issue?

@DjDeveloperr
Copy link
Member

Closing as fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something isn't working documentation 📔 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants