Skip to content

Commit 0c3c79d

Browse files
committed
Update type files
1 parent 2990362 commit 0c3c79d

5 files changed

Lines changed: 29 additions & 201 deletions

File tree

packages/preact/types/index.d.ts

Lines changed: 2 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,2 @@
1-
// TypeScript Version: 3.4
2-
3-
import {
4-
h,
5-
Context,
6-
AnyComponent,
7-
FunctionComponent
8-
} from 'preact'
9-
10-
/**
11-
* Mapping of names for JSX components to React components
12-
*/
13-
interface ComponentDictionary {
14-
[name: string]: AnyComponent<any>
15-
}
16-
17-
/**
18-
* Prop type that includes a component dictionary
19-
*/
20-
interface ComponentsProp {
21-
/**
22-
* Mapping of names for JSX components to React components
23-
*/
24-
components?: ComponentDictionary,
25-
}
26-
27-
/**
28-
* Direct access to the MDX React Context
29-
*/
30-
declare const MDXContext: Context<ComponentsProp>
31-
32-
/**
33-
* Provider for MDX context
34-
*/
35-
declare const MDXProvider: FunctionComponent<ComponentsProp>
36-
37-
/**
38-
* Gets components from the MDX Context
39-
*
40-
* @param components additional components to include
41-
* @returns all components from context with overrides from components parameter
42-
*/
43-
declare function useMDXComponents(
44-
components: ComponentDictionary | (() => ComponentDictionary)
45-
): ComponentDictionary
46-
47-
/**
48-
* High order component that passes components prop to child
49-
*
50-
* @param child Component being wrapped
51-
*/
52-
declare function withMDXComponents(
53-
child: AnyComponent<ComponentsProp>
54-
): ReactElement | null
55-
56-
/**
57-
* Preact hyperscript function wrapped with handler for MDX content
58-
*/
59-
declare const mdx: typeof h
60-
61-
export {
62-
ComponentDictionary,
63-
ComponentsProp,
64-
MDXContext,
65-
MDXProvider,
66-
useMDXComponents,
67-
withMDXComponents,
68-
mdx
69-
}
1+
export { default as mdx } from "./create-element";
2+
export { default as MDXContext, MDXProvider, useMDXComponents, withMDXComponents } from "./context";

packages/react/types/index.d.ts

Lines changed: 2 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,2 @@
1-
// TypeScript Version: 3.4
2-
3-
import {
4-
Context,
5-
Consumer,
6-
ComponentType,
7-
FunctionComponent,
8-
ReactElement,
9-
createElement
10-
} from 'react'
11-
12-
/**
13-
* Mapping of names for JSX components to React components
14-
*/
15-
interface ComponentDictionary {
16-
[name: string]: ComponentType<any>
17-
}
18-
19-
/**
20-
* Prop type that includes a component dictionary
21-
*/
22-
interface ComponentsProp {
23-
/**
24-
* Mapping of names for JSX components to React components
25-
*/
26-
components?: ComponentDictionary,
27-
/**
28-
* Turn off outer component context
29-
*
30-
* @defaultValue false
31-
*/
32-
disableParentContext?: boolean
33-
}
34-
35-
/**
36-
* Direct access to the MDX React Context
37-
*/
38-
declare const MDXContext: Context<ComponentsProp>
39-
40-
/**
41-
* Provider for MDX context
42-
*/
43-
declare const MDXProvider: FunctionComponent<ComponentsProp>
44-
45-
/**
46-
* Gets components from the MDX Context
47-
*
48-
* @param components additional components to include
49-
* @returns all components from context with overrides from components parameter
50-
*/
51-
declare function useMDXComponents(
52-
components: ComponentDictionary | (() => ComponentDictionary)
53-
): ComponentDictionary
54-
55-
/**
56-
* High order component that passes components prop to child
57-
*
58-
* @param child Component being wrapped
59-
*/
60-
declare function withMDXComponents(
61-
child: ComponentType<ComponentsProp>
62-
): ReactElement | null
63-
64-
/**
65-
* React createElement function wrapped with handler for MDX content
66-
*/
67-
declare const mdx: typeof createElement
68-
69-
export {
70-
ComponentDictionary,
71-
ComponentsProp,
72-
MDXContext,
73-
MDXProvider,
74-
useMDXComponents,
75-
withMDXComponents,
76-
mdx
77-
}
1+
export { default as mdx } from "./create-element";
2+
export { default as MDXContext, MDXProvider, useMDXComponents, withMDXComponents } from "./context";

packages/runtime/types/index.d.ts

Lines changed: 9 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,9 @@
1-
// TypeScript Version: 3.5
2-
3-
import {FunctionComponent} from 'react'
4-
import {Options} from '@mdx-js/mdx'
5-
import {ComponentsProp} from '@mdx-js/react'
6-
7-
/**
8-
* Properties for the MDX Runtime component
9-
*/
10-
export interface MDXRuntimeProps
11-
extends Omit<Options, 'footnotes' | 'compilers'>,
12-
Partial<ComponentsProp> {
13-
/**
14-
* MDX text
15-
*/
16-
children?: string
17-
18-
/**
19-
* Values in usable in MDX scope
20-
*/
21-
scope?: {
22-
[variableName: string]: unknown
23-
}
24-
}
25-
26-
/**
27-
* Renders child MDX text as a React component
28-
*/
29-
declare const mdxRuntime: FunctionComponent<MDXRuntimeProps>
30-
31-
export default mdxRuntime
1+
declare function _default({ scope, components, remarkPlugins, rehypePlugins, children, ...props }: {
2+
[x: string]: any;
3+
scope?: {};
4+
components?: {};
5+
remarkPlugins?: any[];
6+
rehypePlugins?: any[];
7+
children: any;
8+
}): any;
9+
export default _default;

packages/vue/types/index.d.ts

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,2 @@
1-
// TypeScript Version: 3.4
2-
3-
import {CreateElement} from 'vue'
4-
5-
/**
6-
* Vue createElement function wrapped with handler for MDX content
7-
*/
8-
declare const createElement: CreateElement
9-
10-
export default createElement
1+
export { default as mdx } from "./create-element";
2+
export { default as MDXProvider } from "./mdx-provider";

yarn.lock

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16701,12 +16701,10 @@ mkdirp-promise@^5.0.1:
1670116701
dependencies:
1670216702
mkdirp "*"
1670316703

16704-
mkdirp@*, "mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@^0.5.3, mkdirp@^0.5.5, mkdirp@~0.5.1:
16705-
version "0.5.5"
16706-
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.5.tgz#d91cefd62d1436ca0f41620e251288d420099def"
16707-
integrity sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==
16708-
dependencies:
16709-
minimist "^1.2.5"
16704+
mkdirp@*, mkdirp@^1.0.4:
16705+
version "1.0.4"
16706+
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
16707+
integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==
1671016708

1671116709
mkdirp@0.5.3:
1671216710
version "0.5.3"
@@ -16715,10 +16713,12 @@ mkdirp@0.5.3:
1671516713
dependencies:
1671616714
minimist "^1.2.5"
1671716715

16718-
mkdirp@^1.0.4:
16719-
version "1.0.4"
16720-
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
16721-
integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==
16716+
"mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@^0.5.3, mkdirp@^0.5.5, mkdirp@~0.5.1:
16717+
version "0.5.5"
16718+
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.5.tgz#d91cefd62d1436ca0f41620e251288d420099def"
16719+
integrity sha512-NKmAlESf6jMGym1++R0Ra7wvhV+wFW63FaSOFPwRahvea0gMUcGUhVeAg/0BC0wiv9ih5NYPB1Wn1UEI1/L+xQ==
16720+
dependencies:
16721+
minimist "^1.2.5"
1672216722

1672316723
modify-values@^1.0.0:
1672416724
version "1.0.1"
@@ -20474,7 +20474,7 @@ read@1, read@^1.0.7, read@~1.0.1:
2047420474
dependencies:
2047520475
mute-stream "~0.0.4"
2047620476

20477-
"readable-stream@1 || 2", "readable-stream@2 || 3", readable-stream@^2.0.0, readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.6, readable-stream@^2.1.5, readable-stream@^2.2.2, readable-stream@^2.3.0, readable-stream@^2.3.3, readable-stream@^2.3.5, readable-stream@^2.3.6, readable-stream@~2.3.3, readable-stream@~2.3.6:
20477+
"readable-stream@1 || 2", readable-stream@^2.0.0, readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.6, readable-stream@^2.1.5, readable-stream@^2.2.2, readable-stream@^2.3.0, readable-stream@^2.3.3, readable-stream@^2.3.5, readable-stream@^2.3.6, readable-stream@~2.3.3, readable-stream@~2.3.6:
2047820478
version "2.3.7"
2047920479
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.7.tgz#1eca1cf711aef814c04f62252a36a62f6cb23b57"
2048020480
integrity sha512-Ebho8K4jIbHAxnuxi7o42OrZgF/ZTNcsZj6nRKyUmkhLFq8CHItp/fy6hQZuZmP/n3yZ9VBUbp4zz/mX8hmYPw==
@@ -20487,7 +20487,7 @@ read@1, read@^1.0.7, read@~1.0.1:
2048720487
string_decoder "~1.1.1"
2048820488
util-deprecate "~1.0.1"
2048920489

20490-
readable-stream@3, readable-stream@^3.0.2, readable-stream@^3.0.6, readable-stream@^3.1.1, readable-stream@^3.4.0, readable-stream@^3.5.0, readable-stream@^3.6.0:
20490+
"readable-stream@2 || 3", readable-stream@3, readable-stream@^3.0.2, readable-stream@^3.0.6, readable-stream@^3.1.1, readable-stream@^3.4.0, readable-stream@^3.5.0, readable-stream@^3.6.0:
2049120491
version "3.6.0"
2049220492
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-3.6.0.tgz#337bbda3adc0706bd3e024426a286d4b4b2c9198"
2049320493
integrity sha512-BViHy7LKeTz4oNnkcLJ+lVSL6vpiFeX6/d3oSH8zCW7UxP2onchk+vTGB143xuFjHS3deTgkKoXXymXqymiIdA==
@@ -22292,12 +22292,12 @@ sade@^1.4.2, sade@^1.7.4:
2229222292
dependencies:
2229322293
mri "^1.1.0"
2229422294

22295-
safe-buffer@5.1.2, safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
22295+
safe-buffer@5.1.2, safe-buffer@~5.1.0, safe-buffer@~5.1.1:
2229622296
version "5.1.2"
2229722297
resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.1.2.tgz#991ec69d296e0313747d59bdfd2b745c35f8828d"
2229822298
integrity sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==
2229922299

22300-
safe-buffer@^5.2.0:
22300+
safe-buffer@^5.0.1, safe-buffer@^5.1.0, safe-buffer@^5.1.1, safe-buffer@^5.1.2, safe-buffer@^5.2.0:
2230122301
version "5.2.1"
2230222302
resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6"
2230322303
integrity sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==

0 commit comments

Comments
 (0)