Skip to content

Commit 5243f37

Browse files
committed
refactor: rename to remoteConfigUrl
1 parent d102547 commit 5243f37

4 files changed

Lines changed: 9 additions & 9 deletions

File tree

src/generators/web/index.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export default createLazyGenerator({
3434
useAbsoluteURLs: false,
3535
editURL: `${GITHUB_EDIT_URL}/doc/api{path}.md`,
3636
pageURL: '{baseURL}/latest-{version}/api{path}.html',
37-
remoteConfig: 'https://nodejs.org/site.json',
37+
remoteConfigUrl: 'https://nodejs.org/site.json',
3838
imports: {
3939
'#theme/Logo': '@node-core/ui-components/Common/NodejsLogo',
4040
'#theme/Navigation': join(import.meta.dirname, './ui/components/NavBar'),

src/generators/web/ui/components/AnnouncementBanner/RemoteLoadableBanner.jsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ import { lazy, Suspense } from 'preact/compat';
33
import AnnouncementBanner from './index.jsx';
44
import { loadBanners } from './loadBanners.mjs';
55

6-
import { remoteConfig, version } from '#theme/config';
6+
import { remoteConfigUrl, version } from '#theme/config';
77

88
// TODO: Revisit SERVER global usage (https://github.com/nodejs/doc-kit/issues/353)
99
const LazyBanners = SERVER
1010
? null
1111
: lazy(async () => {
12-
const active = await loadBanners(remoteConfig, version.major);
12+
const active = await loadBanners(remoteConfigUrl, version.major);
1313

1414
if (!active.length) {
1515
return { default: () => null };

src/generators/web/ui/components/AnnouncementBanner/loadBanners.mjs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ import { isBannerActive } from '../../utils/banner.mjs';
22

33
/**
44
* Fetches and returns active banners for the given version.
5-
* Returns an empty array when remoteConfig is absent, the response is not ok,
5+
* Returns an empty array when remoteConfigUrl is absent, the response is not ok,
66
* or on any fetch/parse failure.
77
*
8-
* @param {string | undefined} remoteConfig
8+
* @param {string | undefined} remoteConfigUrl
99
* @param {number | null} versionMajor
1010
* @returns {Promise<Array<import('./types.d.ts').BannerEntry>>}
1111
*/
12-
export const loadBanners = async (remoteConfig, versionMajor) => {
13-
if (!remoteConfig) {
12+
export const loadBanners = async (remoteConfigUrl, versionMajor) => {
13+
if (!remoteConfigUrl) {
1414
return [];
1515
}
1616

1717
try {
18-
const res = await fetch(remoteConfig);
18+
const res = await fetch(remoteConfigUrl);
1919

2020
/** @type {import('./types.d.ts').RemoteConfig} */
2121
const { websiteBanners = {} } = await res.json();

src/generators/web/ui/types.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ declare module '#theme/config' {
3333
export const editURL: string;
3434
export const pages: Array<[string, string]>;
3535
export const languageDisplayNameMap: Map<string[], string>;
36-
export const remoteConfig: string;
36+
export const remoteConfigUrl: string;
3737
}
3838

3939
// Omit Primitives from Metadata

0 commit comments

Comments
 (0)