Skip to content

feat: add getReplacementDescription util #488

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

Closed
gameroman wants to merge 1 commit into from
Closed

feat: add getReplacementDescription util #488

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
9 changes: 8 additions & 1 deletion src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type {KnownUrl} from './types.js';
import type {KnownUrl, ModuleReplacement} from './types.js';

export function resolveDocUrl(url?: KnownUrl): string | null {
if (!url) return null;
Expand All @@ -15,3 +15,10 @@ export function resolveDocUrl(url?: KnownUrl): string | null {
return null;
}
}

export function getReplacementDescription(
replacement: ModuleReplacement
): string | undefined {
if (!('description' in replacement)) return undefined;
return replacement.description;
}