@volar/source-map
TypeScript icon, indicating that this package has built-in type declarations

2.3.4 • Public • Published

@volar/source-map

Provides functionality related to source maps.

API

This package exports a SourceMap class with the following methods:

  • getSourceOffset(generatedOffset: number): Returns the source offset for a given generated offset.

  • getGeneratedOffset(sourceOffset: number): Returns the generated offset for a given source offset.

  • getSourceOffsets(generatedOffset: number): Returns all source offsets for a given generated offset.

  • getGeneratedOffsets(sourceOffset: number): Returns all generated offsets for a given source offset.

Data Structures

Mapping

The Mapping is a tuple that represents a mapping in the source map. It consists of the following elements:

  • source: A string representing the source file. This can be undefined.
  • sourceOffsets: Offsets in the source code.
  • generatedOffsets: Offsets in the generated code.
  • data: The data associated with this mapping. The type of this data is generic and can be specified when creating a SourceMap instance.

Here is an example of a Mapping:

let mapping: Mapping<MyDataType> = {
    source: '.../sourceFile.ts',
    sourceOffsets: [10],
    generatedOffsets: [30],
	lengths: [10],
    data: myData,
};

In this example, myData is of type MyDataType, which is the type specified for the SourceMap instance.

Remember to replace MyDataType and myData with actual types and data that are relevant to your project.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Readme

Keywords

none

Package Sidebar

Install

npm i @volar/source-map

Weekly Downloads

1,869,354

Version

2.3.4

License

MIT

Unpacked Size

12.7 kB

Total Files

11

Last publish

Collaborators

  • johnsoncodehk