docs: add jsdocs - Githubissues

unjs / unbuild

📦 An unified javascript build system

MIT License

2.19k stars 84 forks source link

docs: add jsdocs #363

Closed RSS1102 closed 4 weeks ago

RSS1102 commented 5 months ago

close #219

🔗 Linked issue

❓ Type of change

[x] 📖 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

[x] I have linked an issue or discussion.
[ ] I have updated the documentation accordingly.

RSS1102 commented 5 months ago

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?