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

Let package author customize wildcard import identifier in usage block #725

Open
lucacasonato opened this issue Sep 11, 2024 · 0 comments
Open
Labels
docs gen Related to the documentation generation feature New feature or request

Comments

@lucacasonato
Copy link
Member

Example:
image

Right now it is always mod. It would be nice if this was customizable by the module author, so that it could say import * as oauth from "@panva/oauth4webapi".

I suggest we add a module level JSDoc tag for this: @wildcardident <ident>. You could then specify it with:

/**
 * This module does xyz.
 * 
 * @module
 * @wildcardident oauth
 */

export ...
@lucacasonato lucacasonato added feature New feature or request docs gen Related to the documentation generation labels Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs gen Related to the documentation generation feature New feature or request
Projects
Status: Needs Triage
Development

No branches or pull requests

1 participant