3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-07 13:22:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor(v2): Expose docusaurus module type aliases to end-users (#2608)

Browse source
This commit is contained in:
Sam Zhou 2020-04-22 08:33:03 -04:00 • committed by GitHub
parent bfeb1044fb
commit 61c917fd8f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 55 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

10
packages/docusaurus-module-type-aliases/package.json Normal file
View file

@ -0,0 +1,10 @@
{
"name": "@docusaurus/module-type-aliases",
"version": "2.0.0-alpha.50",
"description": "Docusaurus module type aliases",
"types": "./src/index.d.ts",
"publishConfig": {
"access": "public"
},
"license": "MIT"
}

43
packages/docusaurus-module-type-aliases/src/index.d.ts vendored Normal file
View file

@ -0,0 +1,43 @@
/**
* 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' {
const clientModules: readonly any[];
export default clientModules;
}
declare module '@generated/docusaurus.config' {
const config: any;
export default config;
}
declare module '@generated/registry' {
const registry: {
readonly [key: string]: [() => Promise<any>, string, string];
};
export default registry;
}
declare module '@generated/routes' {
type Route = {
readonly path: string;
readonly component: any;
readonly exact?: boolean;
};
const routes: Route[];
export default routes;
}
declare module '@generated/routesChunkNames' {
const routesChunkNames: any;
export default routesChunkNames;
}
declare module '@theme/*' {
const component: any;
export default component;
}

1
packages/docusaurus/package.json
View file

@ -29,6 +29,7 @@
"url": "https://github.com/facebook/docusaurus/issues"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^2.0.0-alpha.50",
"@docusaurus/types": "^2.0.0-alpha.50"
},
"dependencies": {

37
packages/docusaurus/src/client/types.d.ts vendored
View file

@ -5,39 +5,4 @@
* LICENSE file in the root directory of this source tree.
*/
declare module '@generated/client-modules' {
const clientModules: readonly any[];
export default clientModules;
}
declare module '@generated/docusaurus.config' {
const config: any;
export default config;
}
declare module '@generated/registry' {
const registry: {
readonly [key: string]: [() => Promise<any>, string, string];
};
export default registry;
}
declare module '@generated/routes' {
type Route = {
readonly path: string;
readonly component: any;
readonly exact?: boolean;
};
const routes: Route[];
export default routes;
}
declare module '@generated/routesChunkNames' {
const routesChunkNames: any;
export default routesChunkNames;
}
declare module '@theme/*' {
const component: any;
export default component;
}
/// <reference types="@docusaurus/module-type-aliases" />