ts-loader
Advanced tools
The ts-loader package is a TypeScript loader for webpack that allows you to transpile TypeScript files (.ts, .tsx) to JavaScript while bundling with webpack. It enables you to integrate TypeScript into your webpack build process.
Transpilation of TypeScript to JavaScript
This feature allows you to compile TypeScript files into JavaScript, enabling you to use TypeScript in your webpack projects. The code sample shows a webpack configuration that uses ts-loader to process files with .ts or .tsx extensions.
module.exports = {
mode: 'development',
entry: './src/index.ts',
module: {
rules: [
{
test: /\.tsx?$/,
use: 'ts-loader',
exclude: /node_modules/
}
]
},
resolve: {
extensions: ['.tsx', '.ts', '.js']
},
output: {
filename: 'bundle.js',
path: path.resolve(__dirname, 'dist')
}
};Integration with webpack's watch mode
ts-loader works seamlessly with webpack's watch mode, which recompiles your code when changes are detected. This feature is useful for development as it provides a fast feedback loop.
webpack --watchSource map support
ts-loader supports the generation of source maps, which help in debugging by mapping the compiled code back to the original TypeScript source code. The code sample shows how to enable inline source maps in your webpack configuration.
module.exports = {
devtool: 'inline-source-map',
// ... other webpack configuration
};Similar to ts-loader, awesome-typescript-loader is another TypeScript loader for webpack. It offers features like Babel integration and type checking in a separate process. However, it is no longer actively maintained, and users are recommended to switch to ts-loader or other alternatives.
While not a TypeScript-specific loader, babel-loader can be used in conjunction with @babel/preset-typescript to transpile TypeScript code. It is part of the Babel ecosystem and is often used for its broader transformation capabilities and plugin ecosystem.
esbuild-loader uses the esbuild bundler to transpile TypeScript (and other files) at a much faster rate than traditional loaders. It is known for its speed and efficiency, making it a strong alternative to ts-loader, especially in large projects where build time is a concern.
A step by step tutorial is available here.
npm install ts-loader
You will also need to install TypeScript if you have not already.
npm install -g typescript
Take advantage of the Changelog and Upgrade Guide.
Use webpack like normal, including webpack --watch and webpack-dev-server, or through another
build system using the Node.js API.
The current version is compatible with TypeScript 1.5 and with the nightly build. You may experience issues using the nightly build due to its nature, but a full test suite runs against the latest nightly every day to catch incompatibilites early. Please report any issues you experience with the nightly so that they can be fixed promptly.
Create or update webpack.config.js like so:
module.exports = {
entry: './app.ts',
output: {
filename: 'bundle.js'
},
resolve: {
// Add `.ts` and `.tsx` as a resolvable extension.
extensions: ['', '.webpack.js', '.web.js', '.ts', '.tsx', '.js']
},
module: {
loaders: [
// all files with a `.ts` or `.tsx` extension will be handled by `ts-loader`
{ test: /\.ts(x?)$/, loader: 'ts-loader' }
]
}
}
{
"compilerOptions": {
"target": "es5",
"sourceMap": true
},
"files": [
"path/to/declaration.d.ts"
]
}
The tsconfig.json file controls
TypeScript-related options so that your IDE, the tsc command, and this loader all share the
same options. The files property should generally be specified even if its just an empty array.
If the files property is not specified, then all TypeScript files in the directory and
subdirectories will be included, possibly even ones that should not be.
There are two types of options: TypeScript options (aka "compiler options") and loader options.
TypeScript options should be set using a tsconfig.json file. Loader options can be set either
using a query when specifying the loader or through the ts property in the webpack configuration.
module.exports = {
...
module: {
loaders: [
// specify option using query
{ test: /\.ts$/, loader: 'ts-loader?compiler=ntypescript' }
]
},
// specify option using `ts` property
ts: {
compiler: 'ntypescript'
}
}
If you want to speed up compilation significantly you can set this flag.
However, many of the benefits you get from static type checking between
different dependencies in your application will be lost. You should also
set the isolatedModules TypeScript option if you plan to ever make use
of this.
If true, no console.log messages will be emitted. Note that most error messages are emitted via webpack which is not affected by this flag.
Allows use of TypeScript compilers other than the official one. Should be
set to the NPM name of the compiler, eg ntypescript.
Allows you to specify a custom configuration file.
Allows overriding TypeScript options. Should be specified in the same format
as you would do for the compilerOptions property in tsconfig.json.
Advanced option to force files to go through different instances of the TypeScript compiler. Can be used to force segregation between different parts of your code.
Loading css and other resources is possible but you will need to make sure that
you have defined the require function in a declaration file.
declare var require: {
<T>(path: string): T;
(paths: string[], callback: (...modules: any[]) => void): void;
ensure: (paths: string[], callback: (require: <T>(path: string) => T) => void) => void;
};
Then you can simply require assets or chunks per the webpack documentation.
require('!style!css!./style.css');
The same basic process is required for code splitting. In this case, you import modules you need but you
don't directly use them. Instead you require them at split points.
See this example for more details.
The nightly version of TypeScript supports JSX natively. See the JSX test for an example.
npm install
tsc index.ts --module commonjs
The MIT License (MIT)
Copyright (c) 2015 James Brantly
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
v0.5.2
FAQs
TypeScript loader for webpack
The npm package ts-loader receives a total of 4,221,785 weekly downloads. As such, ts-loader popularity was classified as popular.
We found that ts-loader demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.