Skip to content

BREAKING: Break TS build that uses functions.config() #1757

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

Merged
merged 2 commits into from
Oct 30, 2025
Merged

BREAKING: Break TS build that uses functions.config() #1757

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dce72c6
BREAKING: Break TS build that uses functions.config()
taeold Oct 30, 2025
7d7a3bd
Simplify as never cast.
taeold Oct 30, 2025
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
7 changes: 5 additions & 2 deletions spec/v1/config.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,14 @@ import { config } from "../../src/v1/config";

describe("config()", () => {
it("throws an error with migration guidance", () => {
expect(config).to.throw(
expect(() => {
// @ts-expect-error - config is deprecated and typed as never to cause a build error
config();
}).to.throw(
Error,
"functions.config() has been removed in firebase-functions v7. " +
"Migrate to environment parameters using the params module. " +
"Migration guide: https://firebase.google.com/docs/functions/config-env#migrate-config"
);
});
});
});
4 changes: 2 additions & 2 deletions src/v1/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ export { firebaseConfig } from "../common/config";
* Migrate to environment parameters using the `params` module immediately.
* Migration guide: https://firebase.google.com/docs/functions/config-env#migrate-config
*/
export function config(): Record<string, any> {
export const config: never = (() => {
throw new Error(
"functions.config() has been removed in firebase-functions v7. " +
"Migrate to environment parameters using the params module. " +
"Migration guide: https://firebase.google.com/docs/functions/config-env#migrate-config"
);
}
}) as unknown as never;
Copy link
Contributor

@jhuleatt jhuleatt Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does adding in the as unknown do? I tried removing it in the TS playground and it doesn't seem to change anything

Copy link
Contributor Author

@taeold taeold Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

iiuc as unknown basically erases types before and I think I needed to do it to ultimately cast this type as never to prevent tsc from complaining. let me double check to confirm!

Copy link
Contributor Author

@taeold taeold Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed that this isn't necessary. Great catch!

Loading