Skip to content
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.

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

refactor(v2): add ExecutionEnvironment, BrowserOnly, isInternalUrl to type aliases #4387

Merged
merged 1 commit into from
Mar 12, 2021
Merged
Changes from all commits
Commits
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
26 changes: 25 additions & 1 deletion packages/docusaurus-module-type-aliases/src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,36 @@ declare module '@docusaurus/useDocusaurusContext' {
}

declare module '@docusaurus/useBaseUrl' {
export default function (
export default function useBaseUrl(
relativePath: string | undefined,
opts?: {absolute?: true; forcePrependBaseUrl?: true},
): string;
}

declare module '@docusaurus/ExecutionEnvironment' {
const ExecutionEnvironment: {
canUseDOM: boolean;
canUseEventListeners: boolean;
canUseIntersectionObserver: boolean;
canUseViewport: boolean;
};
export default ExecutionEnvironment;
}

declare module '@docusaurus/BrowserOnly' {
export type Props = {
children?: () => JSX.Element;
fallback?: JSX.Element;
};
const BrowserOnly: (props: Props) => JSX.Element | null;
export default BrowserOnly;
}

declare module '@docusaurus/isInternalUrl' {
export function hasProtocol(url: string): boolean;
export default function isInternalUrl(url?: string): boolean;
}

declare module '*.module.css' {
const classes: {readonly [key: string]: string};
export default classes;
Expand Down