Skip to content

Commit

Permalink
Fix typescript module declaration
Browse files Browse the repository at this point in the history
Resolve errors when importing markdown files as components
  • Loading branch information
moiri-gamboni authored and pngwn committed Aug 14, 2024
1 parent c12dd3b commit 91ef99f
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 10 deletions.
5 changes: 5 additions & 0 deletions .changeset/strong-toes-smile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'mdsvex': patch
---

Fix typescript module declaration to resolve errors when importing markdown files as components
18 changes: 8 additions & 10 deletions packages/mdsvex/globals.d.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
declare module '*.svx' {
import type { SvelteComponentDev } from 'svelte/internal';
import type { SvelteComponent } from 'svelte'

export default class Comp extends SvelteComponentDev {
$$prop_def: {};
}
export const metadata: Record<string, any>;
export default class Comp extends SvelteComponent{}

export const metadata: Record<string, unknown>
}

declare module '*.svelte.md' {
import type { SvelteComponentDev } from 'svelte/internal';
import type { SvelteComponent } from 'svelte'

export default class Comp extends SvelteComponent{}

export default class Comp extends SvelteComponentDev {
$$prop_def: {};
}
export const metadata: Record<string, any>;
export const metadata: Record<string, unknown>
}
11 changes: 11 additions & 0 deletions packages/site/src/routes/_docs.svtext
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,17 @@ export default {
}
```

If you use TypeScript, you should also declare an ambient module:
```ts
declare module '*.md' {
import type { SvelteComponent } from 'svelte'

export default class Comp extends SvelteComponent{}

export const metadata: Record<string, unknown>
}
```

Then you can do:

```svx
Expand Down

0 comments on commit 91ef99f

Please sign in to comment.