Skip to content

Commit

Permalink
feat: add configuration typing
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe committed Jul 13, 2021
1 parent 14b83c2 commit 2214ad0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 4 deletions.
31 changes: 27 additions & 4 deletions src/index.ts
@@ -1,14 +1,20 @@
import { defineNuxtModule } from '@nuxt/kit'
import { resolve } from 'upath'
import Critters from 'critters'
import Critters, { Options } from 'critters'

export default defineNuxtModule({
const configKey = 'critters'

interface CrittersModuleOptions {
config?: Options
}

export default defineNuxtModule<CrittersModuleOptions>({
name: 'critters',
configKey: 'critters',
configKey,
defaults: {
// Options passed directly to `critters`
config: {
preload: 'media' as 'media' | 'body' | 'swap' | 'js' | 'js-lazy'
preload: 'media'
}
},
setup (options, nuxt) {
Expand Down Expand Up @@ -36,3 +42,20 @@ export default defineNuxtModule({
})
}
})

declare module '@nuxt/types' {
// Nuxt 2.14+
interface NuxtOptions {
[configKey]: CrittersModuleOptions
}
// Nuxt 2.9 - 2.13
interface Configuration {
[configKey]: CrittersModuleOptions
}
}

declare module '@nuxt/kit' {
interface NuxtConfig {
[configKey]: CrittersModuleOptions
}
}
1 change: 1 addition & 0 deletions tsconfig.json
Expand Up @@ -15,6 +15,7 @@
"allowSyntheticDefaultImports": true,
"types": [
"node",
"@nuxt/types",
"jest"
]
},
Expand Down

0 comments on commit 2214ad0

Please sign in to comment.