types: expose Inject type

[Kapcash]

Types of changes

• Bug fix (a non-breaking change which fixes an issue)
• New feature (a non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Description

When using Typescript, I usually declare my Nuxt plugins as so:

import { Context, Plugin } from '@nuxt/types'
const MyPlugin: Plugin = (ctx: Context, inject: (key: string, value: any) => void) => {})

export default MyPlugin

I have to define the inject function type myself. I think it would be better to actually export the existing type!
This way, if the type changes one day, I won't have to change the definition in all my plugins.

Now it looks like:

import { Context, Plugin, Inject } from '@nuxt/types'
const MyPlugin: Plugin = (ctx: Context, inject: Inject) => {})

export default MyPlugin

What do you think?

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly. (PR: #)
• I have added tests to cover my changes (if not applicable, please state why)
• All new and existing tests are passing.

[codecov-commenter]

Codecov Report

Merging #7985 into dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##              dev    #7985   +/-   ##
=======================================
  Coverage   68.87%   68.87%           
=======================================
  Files          91       91           
  Lines        3849     3849           
  Branches     1043     1043           
=======================================
  Hits         2651     2651           
  Misses        972      972           
  Partials      226      226           

Flag	Coverage Δ
#unittests	68.87% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2c600d5...13f417d. Read the comment docs.

[pi0]

Thanks!

[danielroe]

@Kapcash Just as a note, you shouldn't need to define the types of the function arguments. This should be equally well-typed:

import { Plugin } from '@nuxt/types'
const MyPlugin: Plugin = (ctx, inject) => {
  // ctx and inject are both typed here...
})

export default MyPlugin

[pi0]

@danielroe Agree. Type inference should works too :)

[Kapcash]

That is very true! Thanks for pointing it out.
Are you still considering merging it? As it's a bit useless actually haha

[pi0]

@Kapcash already merged. At least function is internally named now 😊

[Kapcash]

Could have been reverted as the release is not done yet.
Of course, I'll focus on useful types next time ;)

Thanks for your reactivity on PR by the way!