1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-22 15:24:46 -05:00

docs(cli): interfaces used as parameters should be exported (#7500)

Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
This commit is contained in:
Carter Snook 2020-10-19 21:41:40 -05:00 committed by GitHub
parent 623ac9e6df
commit 4ff5003eb6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -174,6 +174,28 @@ export interface PWrite {
export function pwrite(options: PWrite) {}
```
### Export all interfaces that are used as parameters to an exported member
Whenever you are using interfaces that are included in the arguments of an
exported member, you should export the interface that is used. Here is an
example:
```ts
// my_file.ts
export interface Person {
name: string;
age: number;
}
export function createPerson(name: string, age: number): Person {
return { name, age };
}
// mod.ts
export { createPerson } from "./my_file.ts";
export type { Person } from "./my_file.ts";
```
### Minimize dependencies; do not make circular imports.
Although `cli/js` and `std` have no external dependencies, we must still be