@types/source-map-support

What is @types/source-map-support?

@types/source-map-support provides TypeScript type definitions for the source-map-support package, which is used to enhance the debugging experience by providing better stack traces with source maps.

What are @types/source-map-support's main functionalities?

Install Source Map Support

This feature allows you to install source map support in your Node.js application, enabling better stack traces that map to the original source code.

const sourceMapSupport = require('source-map-support');
sourceMapSupport.install();

Uninstall Source Map Support

This feature allows you to uninstall source map support, reverting to the default stack trace behavior.

const sourceMapSupport = require('source-map-support');
sourceMapSupport.uninstall();

Customizing Source Map Retrieval

This feature allows you to customize how source maps are retrieved, providing a function that returns the source map for a given source file.

const sourceMapSupport = require('source-map-support');
sourceMapSupport.install({
  retrieveSourceMap: function(source) {
    if (source === 'compiled.js') {
      return {
        url: 'compiled.js',
        map: fs.readFileSync('compiled.js.map', 'utf8')
      };
    }
    return null;
  }
});

Other packages similar to @types/source-map-support

source-map

The source-map package provides a library for working with source maps, including parsing and generating them. Unlike source-map-support, it does not automatically enhance stack traces but provides the tools to work with source maps directly.

stacktrace-js

stacktrace-js is a library for generating, parsing, and enhancing JavaScript stack traces. It provides more general stack trace manipulation capabilities compared to source-map-support, which focuses specifically on source maps.

error-stack-parser

error-stack-parser is a library for parsing error stack traces into a more readable format. While it does not directly deal with source maps, it can be used in conjunction with source-map-support to improve error handling and debugging.

README

Installation

npm install --save @types/source-map-support

Summary

This package contains type definitions for source-map-support (https://github.com/evanw/node-source-map-support).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/source-map-support.

Additional Details

• Last updated: Tue, 22 Aug 2023 18:04:43 GMT
• Dependencies: @types/source-map
• Global values: none

Credits

These definitions were written by Bart van der Schoor, Jason Cheatham, Alcedo Nathaniel De Guzman Jr, Griffin Yourick, and BendingBender.