Skip to content

Commit 56f3385

Browse files
committed
feat: add TypeScript typing definition
1 parent 442583a commit 56f3385

2 files changed

Lines changed: 31 additions & 0 deletions

File tree

index.d.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
export = modifyCode;
2+
export as namespace modifyCode;
3+
4+
interface ModifyCode {
5+
prepend(str: string) : ModifyCode,
6+
append(str: string) : ModifyCode,
7+
insert(start: number, str: string) : ModifyCode,
8+
replace(start: number, end: number, str: string) : ModifyCode,
9+
delete(start: number, end: number) : ModifyCode,
10+
transform(): ModifyCodeResult
11+
}
12+
13+
interface ModifyCodeResult {
14+
code: string,
15+
map: SourceMap
16+
}
17+
18+
interface SourceMap {
19+
version: number,
20+
// file, sources, sourcesContent are optional in spec,
21+
// but ModifyCodeResult always have them.
22+
file: string,
23+
sources: string[],
24+
sourcesContent: string[],
25+
sourceRoot?: string,
26+
names?: string[],
27+
mappings: string
28+
}
29+
30+
declare function modifyCode(code: string, filePath?: string): ModifyCode;

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "0.2.1",
44
"description": "Modify JavaScript code, generate source map for the modification.",
55
"main": "index.js",
6+
"types": "index.d.ts",
67
"files": [
78
"index.js",
89
"tokenize.js"

0 commit comments

Comments
 (0)