unplugin-print-type
Experimental TS type printer.
Print TS type deeply handle all subtypes. Useful if you want to document types.
Features
- Render type during build (Zero runtime-code)
- Render type aliases and interfaces to string
- Resolve imported types
Usage
import type { UserRole } from './user'
interface User {
name: string
role: UserRole
}
console.log(`User type: ${PrintType<User>()}`)Output
User type: {
name: string
role: 'admin' | 'user'
}
Install
npm i unplugin-print-typeVite
// vite.config.ts
import Untype from 'unplugin-print-type/vite'
export default defineConfig({
plugins: [
Untype({ /* options */ }),
],
})Example: playground/
Webpack
// webpack.config.js
module.exports = {
/* ... */
plugins: [
require('unplugin-print-type/webpack')({ /* options */ })
]
}Nuxt
// nuxt.config.js
export default {
buildModules: [
['unplugin-print-type/nuxt', { /* options */ }],
],
}This module works for both Nuxt 2 and Nuxt Vite
Vue CLI
// vue.config.js
module.exports = {
configureWebpack: {
plugins: [
require('unplugin-print-type/webpack')({ /* options */ }),
],
},
}