Skip to content

docs(shared): reframe the apiUrlFromPublishableKey return type rationale #8794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jacekradko wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

docs(shared): reframe the apiUrlFromPublishableKey return type rationale #8794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/apiurl-return-type-rationale.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
10 changes: 5 additions & 5 deletions packages/shared/src/apiUrlFromPublishableKey.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ import {
} from './constants';
import { parsePublishableKey } from './keys';

// The return type is annotated explicitly so the declaration emit stays
// deterministic. An inferred union's member order comes from TypeScript's
// global type-id assignment, which shifts as unrelated code changes and made
// break-check report phantom diffs for this export. These literals mirror the
// *_API_URL constants returned below; tsc errors here if a value ever drifts.
// Explicit return type per the repo TypeScript guideline for public APIs,
// written as literals because `typeof CONST` would pull a hashed `_chunks/*`
// import into the published d.ts. The literals mirror the *_API_URL constants
// returned below (tsc errors here if a value drifts), and the pinned order
// keeps the declaration emit deterministic where inference is not.
/**
* Get the correct API url based on the publishable key.
*
Expand Down
Loading