AltimateAI / AltimateAI/altimate-code

chore: add @internal JSDoc to sanitizeConnectionString export

Open
#668 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
811
Forks
134
Avg merge
3d 2h
Merged PRs (30d)
50

Description

Found during v0.5.20 release review. Deferred because: API surface design decision.

`sanitizeConnectionString` is exported from `packages/drivers/src/index.ts`, making it part of the public API surface. The function has an intentional ambiguity guard that bails on certain valid URIs. External consumers could depend on behavior that may change. Consider adding `@internal` JSDoc tag or un-exporting.

Flagged by: Tech Lead, PM.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.