Skip to content

Commit e385649

Browse files
authored
api docs (#161)
1 parent 7bbe996 commit e385649

File tree

2 files changed

+130
-0
lines changed

2 files changed

+130
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# @dojo/loader
2+
<!-- start-github-only -->
23

34
[![Build Status](https://travis-ci.org/dojo/loader.svg?branch=master)](https://travis-ci.org/dojo/loader)
45
[![codecov.io](http://codecov.io/github/dojo/loader/coverage.svg?branch=master)](http://codecov.io/github/dojo/loader?branch=master)
@@ -18,6 +19,7 @@ This package provides a JavaScript AMD loader useful in applications running in
1819
- [Licensing information](#licensing-information)
1920

2021
## Note
22+
<!-- end-github-only -->
2123

2224
We strongly recommend using the `@dojo/cli` build tools for a Dojo 2 application over a runtime loader such as `@dojo/loader`.
2325

@@ -92,3 +94,9 @@ Test cases MUST be written using Intern using the Object test interface and Asse
9294
## Licensing information
9395

9496
© 2004–2018 [JS Foundation](https://js.foundation/) & contributors. [New BSD](http://opensource.org/licenses/BSD-3-Clause) license.
97+
98+
<!-- doc-viewer-config
99+
{
100+
"api": "docs/api.json",
101+
}
102+
-->

docs/api.json

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
{
2+
"id": 0,
3+
"name": "@dojo/loader",
4+
"kind": 0,
5+
"flags": {
6+
"__visited__": true
7+
},
8+
"children": [
9+
{
10+
"id": 1,
11+
"name": "\"loader\"",
12+
"kind": 1,
13+
"kindString": "External module",
14+
"flags": {
15+
"isExported": true,
16+
"__visited__": true
17+
},
18+
"originalName": "src/loader.ts",
19+
"children": [
20+
{
21+
"id": 2,
22+
"name": "Packages",
23+
"kind": 32,
24+
"kindString": "Variable",
25+
"flags": {
26+
"__visited__": true
27+
},
28+
"sources": [
29+
{
30+
"fileName": "loader.ts",
31+
"line": 7,
32+
"character": 20
33+
}
34+
],
35+
"type": {
36+
"type": "union",
37+
"types": [
38+
{
39+
"type": "reflection",
40+
"declaration": {
41+
"id": 3,
42+
"name": "__type",
43+
"kind": 65536,
44+
"kindString": "Type literal",
45+
"flags": {
46+
"__visited__": true
47+
},
48+
"indexSignature": [
49+
{
50+
"id": 4,
51+
"name": "__index",
52+
"kind": 8192,
53+
"kindString": "Index signature",
54+
"flags": {
55+
"__visited__": true
56+
},
57+
"parameters": [
58+
{
59+
"id": 5,
60+
"name": "key",
61+
"kind": 32768,
62+
"kindString": "Parameter",
63+
"flags": {
64+
"__visited__": true
65+
},
66+
"type": {
67+
"type": "intrinsic",
68+
"name": "string"
69+
}
70+
}
71+
],
72+
"type": {
73+
"type": "intrinsic",
74+
"name": "any"
75+
}
76+
}
77+
],
78+
"sources": [
79+
{
80+
"fileName": "loader.ts",
81+
"line": 7,
82+
"character": 21
83+
}
84+
]
85+
}
86+
},
87+
{
88+
"type": "intrinsic",
89+
"name": "undefined"
90+
}
91+
]
92+
}
93+
}
94+
],
95+
"groups": [
96+
{
97+
"title": "Variables",
98+
"kind": 32,
99+
"children": [
100+
2
101+
]
102+
}
103+
],
104+
"sources": [
105+
{
106+
"fileName": "loader.ts",
107+
"line": 1,
108+
"character": 0
109+
}
110+
]
111+
}
112+
],
113+
"groups": [
114+
{
115+
"title": "External modules",
116+
"kind": 1,
117+
"children": [
118+
1
119+
]
120+
}
121+
]
122+
}

0 commit comments

Comments
 (0)