# @volar/source-map

> Provides functionality related to source maps.

Latest version **2.4.28** (published 2026-01-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @volar/source-map
pnpm add @volar/source-map
yarn add @volar/source-map
bun add @volar/source-map
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.4.28 |
| Published | 2026-01-31 |
| First published | 2021-05-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1255 |
| Maintainers | johnsoncodehk |

## Links

- npm: https://www.npmjs.com/package/@volar/source-map
- Repository: https://github.com/volarjs/volar.js
- Homepage: https://github.com/volarjs/volar.js#readme
- Issues: https://github.com/volarjs/volar.js/issues
- npm.io page: https://npm.io/package/@volar/source-map

## Recent versions

- 2.4.28 (latest) — 2026-01-31
- 2.4.0-alpha.20 (next) — 2024-08-19
- 2.0.0-alpha.12 (@volar/language-core@2.0.0-alpha.12) — 2023-12-21
- 2.4.27 — 2025-12-10
- 2.4.26 — 2025-11-25
- 2.4.25 — 2025-11-25
- 2.4.24 — 2025-11-25
- 2.4.23 — 2025-08-08
- 2.4.22 — 2025-07-27
- 2.4.21 — 2025-07-27
- 2.4.20 — 2025-07-18
- 2.4.19 — 2025-07-15
- 2.4.18 — 2025-07-09
- 2.4.17 — 2025-07-02
- 2.4.16 — 2025-07-01
- … 399 more at https://npm.io/package/@volar/source-map/versions

## README

# @volar/source-map

Provides functionality related to source maps.

## API

### This package exports a `SourceMap` class with the following methods:

Params:

- `fallbackToAnyMatch`(default: false): allow the start and end offsets to come from different mappings.
- `filter?: (data: Data) => boolean)`(default: undefined):  according to mapping: Mapping<MyDataType>.data, filter out offsets that do not meet the custom conditions.

Methods:

- `toSourceRange(generatedStart: number, generatedEnd: number, fallbackToAnyMatch: boolean, filter?: (data: Data) => boolean)`: Returns all source start and end offsets for the given generated start and end offsets.

- `toGeneratedRange(sourceStart: number, sourceEnd: number, fallbackToAnyMatch: boolean, filter?: (data: Data) => boolean) `: Returns all generated start and end offsets for the given source start and end offsets.

- `toSourceLocation(generatedOffset: number, filter?: (data: Data) => boolean)`: Returns all source offsets for a given generated offset.

- `toGeneratedLocation(sourceOffset: number, filter?: (data: Data) => boolean)`: 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`:

```ts
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](LICENSE) file for more details.

---
_Source: https://npm.io/package/@volar/source-map · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._