3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 00:39:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type (#7080)

Browse source 
* refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type

* fix
This commit is contained in:
Joshua Chen 2022-03-31 19:16:07 +08:00 • committed by GitHub
parent ce2b631455
commit 24c205a835
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
38 changed files with 145 additions and 138 deletions
Download patch file Download diff file Expand all files Collapse all files

16
packages/docusaurus-types/src/index.d.ts vendored
View file

@ -86,7 +86,7 @@ export type DocusaurusConfig = {
| string
| {
src: string;
[key: string]: unknown;
[key: string]: string | boolean | undefined;
}
)[];
clientModules: string[];
@ -96,7 +96,7 @@ export type DocusaurusConfig = {
| string
| {
href: string;
[key: string]: unknown;
[key: string]: string | boolean | undefined;
}
)[];
titleDelimiter?: string;
@ -304,16 +304,16 @@ export type ThemeConfigValidationContext<T> = {
export type Plugin<Content = unknown> = {
name: string;
loadContent?: () => Promise<Content>;
loadContent?: () => Promise<Content> | Content;
contentLoaded?: (args: {
/** the content loaded by this plugin instance */
content: Content; //
/** content loaded by ALL the plugins */
allContent: AllContent;
actions: PluginContentLoadedActions;
}) => Promise<void>;
}) => Promise<void> | void;
routesLoaded?: (routes: RouteConfig[]) => void; // TODO remove soon, deprecated (alpha-60)
postBuild?: (props: Props & {content: Content}) => Promise<void>;
postBuild?: (props: Props & {content: Content}) => Promise<void> | void;
// TODO refactor the configureWebpack API surface: use an object instead of
// multiple params (requires breaking change)
configureWebpack?: (
@ -342,8 +342,10 @@ export type Plugin<Content = unknown> = {
// translations
getTranslationFiles?: (args: {
content: Content;
}) => Promise<TranslationFile[]>;
getDefaultCodeTranslationMessages?: () => Promise<{[id: string]: string}>;
}) => Promise<TranslationFile[]> | TranslationFile[];
getDefaultCodeTranslationMessages?: () =>
| Promise<{[id: string]: string}>
| {[id: string]: string};
translateContent?: (args: {
/** The content loaded by this plugin instance. */
content: Content;