Skip to content

Commit 5238189

Browse files
committed
update
1 parent 2b55a41 commit 5238189

1 file changed

Lines changed: 2 additions & 19 deletions

File tree

.agent/rules/typescript.mdc

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -443,28 +443,11 @@ Avoid private static methods; prefer module-level functions instead. Never use
443443

444444
Always include parentheses in constructor calls: `new Foo()`, not `new Foo`.
445445

446-
### 7.7 Internal Methods and `@private` JSDoc
447-
448-
When a method or constructor must be accessible to internal code and tests but
449-
should not be used by consumers, mark it with `@private` JSDoc. Do not export
450-
the options interface from `index.ts`.
451-
452-
```typescript
453-
/**
454-
* Do not use this constructor directly. Use {@link MyClass.create} instead.
455-
* This constructor is only meant for internal and testing use.
456-
*
457-
* @private
458-
*/
459-
constructor(options: MyClassOptions) { ... }
460-
```
461-
462-
### 7.8 API Surface Minimization
446+
### 7.7 API Surface Minimization
463447

464448
Default to the smallest public API surface. Only export from `index.ts` what
465449
consumers need. Internal types (options interfaces, schemas, helper functions)
466-
must not be re-exported. Use `@private` JSDoc for methods that are technically
467-
accessible but not part of the public contract.
450+
must not be re-exported.
468451

469452
---
470453

0 commit comments

Comments
 (0)