forked from facebook/docusaurus
/
index.d.ts
311 lines (250 loc) · 8.51 KB
/
index.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
declare module '@generated/client-modules' {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const clientModules: readonly any[];
export default clientModules;
}
declare module '@generated/docusaurus.config' {
import type {DocusaurusConfig} from '@docusaurus/types';
const config: DocusaurusConfig;
export default config;
}
declare module '@generated/site-metadata' {
import type {DocusaurusSiteMetadata} from '@docusaurus/types';
const siteMetadata: DocusaurusSiteMetadata;
export default siteMetadata;
}
declare module '@generated/registry' {
const registry: {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
readonly [key: string]: [() => Promise<any>, string, string];
};
export default registry;
}
declare module '@generated/routes' {
import type {RouteConfig} from 'react-router-config';
type Route = {
readonly path: string;
readonly component: RouteConfig['component'];
readonly exact?: boolean;
readonly routes?: Route[];
};
const routes: Route[];
export default routes;
}
declare module '@generated/routesChunkNames' {
const routesChunkNames: Record<string, Record<string, string>>;
export default routesChunkNames;
}
declare module '@generated/globalData' {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const globalData: Record<string, any>;
export default globalData;
}
declare module '@generated/i18n' {
const i18n: {
defaultLocale: string;
locales: [string, ...string[]];
currentLocale: string;
localeConfigs: Record<string, {label: string; direction: string}>;
};
export default i18n;
}
declare module '@generated/codeTranslations' {
const codeTranslations: Record<string, string>;
export default codeTranslations;
}
declare module '@theme-original/*';
declare module '@theme/Layout' {
import type {ReactNode} from 'react';
export interface Props {
readonly children: ReactNode;
readonly title?: string;
readonly description?: string;
}
export default function Layout(props: Props): JSX.Element;
}
declare module '@theme/Loading' {
import type {LoadingComponentProps} from 'react-loadable';
export default function Loading(props: LoadingComponentProps): JSX.Element;
}
declare module '@theme/NotFound' {
export default function NotFound(): JSX.Element;
}
declare module '@theme/Root' {
import type {ReactNode} from 'react';
export interface Props {
readonly children: ReactNode;
}
export default function Root({children}: Props): JSX.Element;
}
declare module '@docusaurus/constants' {
export const DEFAULT_PLUGIN_ID: 'default';
}
declare module '@docusaurus/Head' {
import type {HelmetProps} from 'react-helmet';
import type {ReactNode} from 'react';
export type HeadProps = HelmetProps & {children: ReactNode};
const Head: (props: HeadProps) => JSX.Element;
export default Head;
}
declare module '@docusaurus/Link' {
import type {CSSProperties, ComponentProps} from 'react';
type NavLinkProps = Partial<import('react-router-dom').NavLinkProps>;
export type LinkProps = NavLinkProps &
ComponentProps<'a'> & {
readonly className?: string;
readonly style?: CSSProperties;
readonly isNavLink?: boolean;
readonly to?: string;
readonly href?: string;
readonly autoAddBaseUrl?: boolean;
// escape hatch in case broken links check is annoying for a specific link
readonly 'data-noBrokenLinkCheck'?: boolean;
};
const Link: (props: LinkProps) => JSX.Element;
export default Link;
}
declare module '@docusaurus/Interpolate' {
import type {ReactNode} from 'react';
// TODO use TS template literal feature to make values typesafe!
// (requires upgrading TS first)
// eslint-disable-next-line @typescript-eslint/no-unused-vars
export type ExtractInterpolatePlaceholders<Str extends string> = string;
export type InterpolateValues<
Str extends string,
Value extends ReactNode,
> = Record<ExtractInterpolatePlaceholders<Str>, Value>;
// TS function overload: if all the values are plain strings, then interpolate returns a simple string
export function interpolate<Str extends string>(
text: Str,
values?: InterpolateValues<Str, string | number>,
): string;
// If values contain any ReactNode, then the return is a ReactNode
export function interpolate<Str extends string, Value extends ReactNode>(
text: Str,
values?: InterpolateValues<Str, Value>,
): ReactNode;
export type InterpolateProps<Str extends string> = {
children: Str;
values?: InterpolateValues<Str, ReactNode>;
};
export default function Interpolate<Str extends string>(
props: InterpolateProps<Str>,
): JSX.Element;
}
declare module '@docusaurus/Translate' {
import type {ReactNode} from 'react';
import type {InterpolateValues} from '@docusaurus/Interpolate';
// TS type to ensure that at least one of id or message is always provided
// (Generic permits to handled message provided as React children)
type IdOrMessage<MessageKey extends 'children' | 'message'> =
| ({[key in MessageKey]: string} & {id?: string})
| ({[key in MessageKey]?: string} & {id: string});
export type TranslateParam<Str extends string> = IdOrMessage<'message'> & {
description?: string;
values?: InterpolateValues<Str, string | number>;
};
export function translate<Str extends string>(
param: TranslateParam<Str>,
values?: InterpolateValues<Str, string | number>,
): string;
export type TranslateProps<Str extends string> = IdOrMessage<'children'> & {
description?: string;
values?: InterpolateValues<Str, ReactNode>;
};
export default function Translate<Str extends string>(
props: TranslateProps<Str>,
): JSX.Element;
}
declare module '@docusaurus/router' {
// eslint-disable-next-line import/no-extraneous-dependencies
export * from 'react-router-dom';
}
declare module '@docusaurus/history' {
// eslint-disable-next-line import/no-extraneous-dependencies
export * from 'history';
}
declare module '@docusaurus/useDocusaurusContext' {
import type {DocusaurusContext} from '@docusaurus/types';
export default function useDocusaurusContext(): DocusaurusContext;
}
declare module '@docusaurus/useIsBrowser' {
export default function useIsBrowser(): boolean;
}
declare module '@docusaurus/useBaseUrl' {
export type BaseUrlOptions = {
forcePrependBaseUrl?: boolean;
absolute?: boolean;
};
export type BaseUrlUtils = {
withBaseUrl: (url: string, options?: BaseUrlOptions) => string;
};
export function useBaseUrlUtils(): BaseUrlUtils;
export default function useBaseUrl(
relativePath: string | undefined,
opts?: BaseUrlOptions,
): string;
}
declare module '@docusaurus/ExecutionEnvironment' {
const ExecutionEnvironment: {
canUseDOM: boolean;
canUseEventListeners: boolean;
canUseIntersectionObserver: boolean;
canUseViewport: boolean;
};
export default ExecutionEnvironment;
}
declare module '@docusaurus/ComponentCreator' {
import type Loadable from 'react-loadable';
function ComponentCreator(
path: string,
hash: string,
): ReturnType<typeof Loadable>;
export default ComponentCreator;
}
declare module '@docusaurus/BrowserOnly' {
export interface Props {
readonly children?: () => JSX.Element;
readonly 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 '@docusaurus/Noop' {
export default function (): null;
}
declare module '@docusaurus/renderRoutes' {
// eslint-disable-next-line import/no-extraneous-dependencies
import {renderRoutes} from 'react-router-config';
export default renderRoutes;
}
declare module '@docusaurus/useGlobalData' {
export function useAllPluginInstancesData<T = unknown>(
pluginName: string,
): Record<string, T>;
export function usePluginData<T = unknown>(
pluginName: string,
pluginId?: string,
): T;
// eslint-disable-next-line @typescript-eslint/no-explicit-any
function useGlobalData(): Record<string, any>;
export default useGlobalData;
}
declare module '*.module.css' {
const classes: {readonly [key: string]: string};
export default classes;
}
declare module '*.css' {
const src: string;
export default src;
}