Skip to content

Commit b671a8f

Browse files
committed
add examples
1 parent f38b14c commit b671a8f

File tree

1 file changed

+48
-4
lines changed

1 file changed

+48
-4
lines changed

README.md

+48-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,55 @@
22

33
Resolve specifiers with import maps.
44

5-
## Usage
5+
## Examples
6+
7+
### Imports
68
```ts
79
import { resolve } from "https://deno.land/x/importmap/mod.ts"
810

911
const specifier = "foo/mod.ts"
10-
const importMap = { imports: { "foo/": "bar/" } }
11-
const resolvedSpecifier = resolve(specifier, importMap) // returns "bar/mod.ts"
12-
```
12+
const importMap = {
13+
imports: {
14+
"foo/": "bar/"
15+
}
16+
}
17+
resolve(specifier, importMap) // returns "bar/mod.ts"
18+
```
19+
20+
### URLs
21+
```ts
22+
import { resolve } from "https://deno.land/x/importmap/mod.ts"
23+
24+
const specifier = "path/mod.ts"
25+
const importMap = {
26+
imports: {
27+
"path/": "https://deno.land/std/path/"
28+
}
29+
}
30+
resolve(specifier, importMap) // returns "https://deno.land/std/path/mod.ts"
31+
```
32+
33+
### Scopes
34+
35+
```ts
36+
import { resolve } from "https://deno.land/x/importmap/mod.ts"
37+
38+
const specifier = "path/mod.ts"
39+
const importMap = {
40+
imports: {
41+
"a": "/a-1.ts",
42+
"b": "/b-1.ts"
43+
},
44+
scopes: {
45+
"/scope2/": {
46+
"a": "/a-2.ts"
47+
}
48+
}
49+
}
50+
resolve("a", importMap, "/scope1/foo.ts") // returns "/a-1.ts"
51+
resolve("b", importMap, "/scope1/foo.ts") // returns "/b-1.ts"
52+
53+
resolve("a", importMap, "/scope2/foo.ts") // returns "/a-2.ts"
54+
resolve("b", importMap, "/scope2/foo.ts") // returns "/b-1.ts"
55+
```
56+

0 commit comments

Comments
 (0)