Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.31 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.31 KB

typescript-plugin-toml

npm version automatic deploy MIT License

A typescript language service plugin providing support for toml files.

example

Usage

npm i -D typescript-plugin-toml # yarn add -D typescript-plugin-toml

And then add this to tsconfig.json.

{
  "compilerOptions": {
    "plugins": [{ "name": "typescript-plugin-toml" }]
  }
}

If you're using VSCode, switch to workspace version.

.const.toml

If the file name ends with .const.toml, the typings will become as if you are using as const.

For example it will be like below.

test.toml and test.const.toml

key = 'val'

index.ts

import test from './test.toml'
import testConst from './test.const.toml'

type Test = typeof test // { key: string }
type TestConst = typeof testConst // { readonly key: 'val' }