docs: fix useSegmentEndpoints typo in README client options - #1322
Open
abueide wants to merge 1 commit into
Open
docs: fix useSegmentEndpoints typo in README client options#1322abueide wants to merge 1 commit into
useSegmentEndpoints typo in README client options#1322abueide wants to merge 1 commit into
Conversation
The README documented the client option as `useSegmentEndpoint` (singular), but the public API is `useSegmentEndpoints` (plural) -- see `Config` in packages/core/src/types.ts and its consumers in analytics.ts, SegmentDestination.ts and constants.ts. Copying the name from the README fails to compile under TypeScript and is silently ignored in JavaScript, leaving proxy/cdnProxy endpoint suffixes unappended. Prettier re-padded the whole table because the option name grew by one character; only the `proxy`, `cdnProxy` and `useSegmentEndpoints` rows changed substantively. Fixes #1145 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README documented the client option as
useSegmentEndpoint(singular), but the public API isuseSegmentEndpoints(plural) -- seeConfigin packages/core/src/types.ts and its consumers in analytics.ts, SegmentDestination.ts and constants.ts.Copying the name from the README fails to compile under TypeScript and is silently ignored in JavaScript, leaving proxy/cdnProxy endpoint suffixes unappended.
Prettier re-padded the whole table because the option name grew by one character; only the
proxy,cdnProxyanduseSegmentEndpointsrows changed substantively.Fixes #1145