Skip to content

Commit df199bb

Browse files
committed
Add TypeScript types
1 parent 7669eda commit df199bb

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,12 @@ module.exports = {
4949
plugins: [
5050
{
5151
resolve: `gatsby-remark-mermaid`,
52-
options: {
52+
options: /** @type {import('gatsby-remark-mermaid').Options} */ ({
5353
mermaidConfig: {
5454
theme: 'neutral',
5555
themeCSS: '.node rect { fill: #fff; }'
5656
}
57-
}
57+
})
5858
}
5959
]
6060
}

index.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import { RemarkMermaidOptions } from 'remark-mermaidjs'
2+
3+
declare namespace gatsbyRemarkMermaid {
4+
type Options = RemarkMermaidOptions
5+
}
6+
7+
declare function gatsbyRemarkMermaid(
8+
gatsbyRemarkOptions: unknown,
9+
options: RemarkMermaidOptions
10+
): Promise<void>
11+
12+
export = gatsbyRemarkMermaid

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"bugs": "https://github.com/remcohaszing/gatsby-remark-mermaid/issues",
1414
"homepage": "https://github.com/remcohaszing/gatsby-remark-mermaid#readme",
1515
"files": [
16+
"index.d.ts",
1617
"index.js"
1718
],
1819
"keywords": [

0 commit comments

Comments
 (0)