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

docs: add jsdocs #363

Merged
merged 4 commits into from
Jun 4, 2024
Merged

docs: add jsdocs #363

merged 4 commits into from
Jun 4, 2024

Conversation

RSS1102
Copy link
Contributor

@RSS1102 RSS1102 commented Jan 23, 2024

close #219

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@RSS1102 RSS1102 mentioned this pull request Jan 23, 2024
1 task
@RSS1102
Copy link
Contributor Author

RSS1102 commented Jan 23, 2024

https://github.com/unjs/unbuild/blob/main/src/types.ts#L94-L104

export interface BuildContext {
   ...
  buildEntries: {
    path: string;
    bytes?: number;
    exports?: string[];
    chunks?: string[];
    chunk?: boolean;
    modules?: { id: string; bytes: number }[];
  }[];
  usedImports: Set<string>;
  warnings: Set<string>;
  hooks: Hookable<BuildHooks>;
}

I don't quite understand the significance of these things. Can you give some explanation?

@Barbapapazes Barbapapazes self-assigned this Jan 27, 2024
@Barbapapazes Barbapapazes added the documentation Improvements or additions to documentation label Jan 27, 2024
@pi0 pi0 changed the title docs: add some comments to document there types docs: add jsdocs Jun 4, 2024
Copy link
Member

@pi0 pi0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@pi0 pi0 merged commit 3ae2de1 into unjs:main Jun 4, 2024
2 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve build option docs
3 participants