Skip to content

Commit 960b838

Browse files
authored
docs(source-map): updated API section based on #207 (#248)
1 parent d239d91 commit 960b838

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

packages/source-map/README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,22 @@ Provides functionality related to source maps.
44

55
## API
66

7-
This package exports a `SourceMap` class with the following methods:
7+
### This package exports a `SourceMap` class with the following methods:
88

9-
- `getSourceOffset(generatedOffset: number)`: Returns the source offset for a given generated offset.
9+
Params:
1010

11-
- `getGeneratedOffset(sourceOffset: number)`: Returns the generated offset for a given source offset.
11+
- `fallbackToAnyMatch`(default: false): allow the start and end offsets to come from different mappings.
12+
- `filter?: (data: Data) => boolean)`(default: undefined): according to mapping: Mapping<MyDataType>.data, filter out offsets that do not meet the custom conditions.
1213

13-
- `getSourceOffsets(generatedOffset: number)`: Returns all source offsets for a given generated offset.
14+
Methods:
1415

15-
- `getGeneratedOffsets(sourceOffset: number)`: Returns all generated offsets for a given source offset.
16+
- `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.
17+
18+
- `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.
19+
20+
- `toSourceLocation(generatedOffset: number, filter?: (data: Data) => boolean)`: Returns all source offsets for a given generated offset.
21+
22+
- `toGeneratedLocation(sourceOffset: number, filter?: (data: Data) => boolean)`: Returns all generated offsets for a given source offset.
1623

1724
## Data Structures
1825

0 commit comments

Comments
 (0)