Skip to content

Commit 8aa35f4

Browse files
jaredgalanisjaredgalanis
committed
add docs for ember-data v5.3.8 and fix urls/links
1 parent 0484477 commit 8aa35f4

File tree

106 files changed

+43501
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+43501
-1
lines changed

‎json-docs/ember-data/5.3.8/classes/ember-data-5.3.8-<Interface> Adapter.json

Lines changed: 600 additions & 0 deletions
Large diffs are not rendered by default.

‎json-docs/ember-data/5.3.8/classes/ember-data-5.3.8-<Interface> Cache.json

Lines changed: 714 additions & 0 deletions
Large diffs are not rendered by default.

‎json-docs/ember-data/5.3.8/classes/ember-data-5.3.8-<Interface> CacheHandler.json

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"data": {
3+
"id": "ember-data-5.3.8-<Interface> CacheHandler",
4+
"type": "class",
5+
"attributes": {
6+
"name": "<Interface> CacheHandler",
7+
"shortname": "<Interface> CacheHandler",
8+
"classitems": [],
9+
"plugins": [],
10+
"extensions": [],
11+
"plugin_for": [],
12+
"extension_for": [],
13+
"module": "@ember-data/request",
14+
"namespace": "",
15+
"file": "../request/src/-private/types.ts",
16+
"line": 209,
17+
"description": "<html><head></head><body><p>The CacheHandler is identical to other handlers ecxept that it\nis allowed to return a value synchronously. This is useful for\nfeatures like reducing microtask queueing when de-duping.</p>\n<p>A RequestManager may only have one CacheHandler, registered via\n<code>manager.useCache(CacheHandler)</code>.</p>\n</body></html>",
18+
"access": "public",
19+
"tagname": "",
20+
"methods": [
21+
{
22+
"file": "../packages/request/src/-private/types.ts",
23+
"line": 221,
24+
"description": "<html><head></head><body><p>Method to implement to handle requests. Receives the request\ncontext and a nextFn to call to pass-along the request to\nother handlers.</p>\n</body></html>",
25+
"itemtype": "method",
26+
"name": "request",
27+
"access": "public",
28+
"tagname": "",
29+
"params": [
30+
{
31+
"name": "context",
32+
"description": ""
33+
},
34+
{
35+
"name": "next",
36+
"description": ""
37+
}
38+
],
39+
"class": "<Interface> CacheHandler",
40+
"module": "@ember-data/request"
41+
}
42+
],
43+
"events": [],
44+
"properties": []
45+
},
46+
"relationships": {
47+
"parent-class": {
48+
"data": null
49+
},
50+
"descendants": {
51+
"data": []
52+
},
53+
"module": {
54+
"data": {
55+
"id": "ember-data-5.3.8-@ember-data/request",
56+
"type": "module"
57+
}
58+
},
59+
"project-version": {
60+
"data": {
61+
"id": "ember-data-5.3.8",
62+
"type": "project-version"
63+
}
64+
}
65+
}
66+
}
67+
}

‎json-docs/ember-data/5.3.8/classes/ember-data-5.3.8-<Interface> CachePolicy.json

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
{
2+
"data": {
3+
"id": "ember-data-5.3.8-<Interface> CachePolicy",
4+
"type": "class",
5+
"attributes": {
6+
"name": "<Interface> CachePolicy",
7+
"shortname": "<Interface> CachePolicy",
8+
"classitems": [],
9+
"plugins": [],
10+
"extensions": [],
11+
"plugin_for": [],
12+
"extension_for": [],
13+
"module": "@ember-data/store",
14+
"namespace": "",
15+
"file": "../store/src/-private/cache-handler.ts",
16+
"line": 30,
17+
"description": "<html><head></head><body><p>A service which an application may provide to the store via\nthe store's <code>lifetimes</code> property to configure the behavior\nof the CacheHandler.</p>\n<p>The default behavior for request lifetimes is to never expire\nunless manually refreshed via <code>cacheOptions.reload</code> or <code>cacheOptions.backgroundReload</code>.</p>\n<p>Implementing this service allows you to programatically define\nwhen a request should be considered expired.</p>\n</body></html>",
18+
"access": "public",
19+
"tagname": "",
20+
"methods": [
21+
{
22+
"file": "../packages/store/src/-private/cache-handler.ts",
23+
"line": 45,
24+
"description": "<html><head></head><body><p>Invoked to determine if the request may be fulfilled from cache\nif possible.</p>\n<p>Note, this is only invoked if the request has a cache-key.</p>\n<p>If no cache entry is found or the entry is hard expired,\nthe request will be fulfilled from the configured request handlers\nand the cache will be updated before returning the response.</p>\n</body></html>",
25+
"itemtype": "method",
26+
"name": "isHardExpired",
27+
"access": "public",
28+
"tagname": "",
29+
"params": [
30+
{
31+
"name": "identifier",
32+
"description": "",
33+
"type": "StableDocumentIdentifier"
34+
},
35+
{
36+
"name": "store",
37+
"description": "",
38+
"type": "Store"
39+
}
40+
],
41+
"return": {
42+
"description": "true if the request is considered hard expired",
43+
"type": "Boolean"
44+
},
45+
"class": "<Interface> CachePolicy",
46+
"module": "@ember-data/store"
47+
},
48+
{
49+
"file": "../packages/store/src/-private/cache-handler.ts",
50+
"line": 62,
51+
"description": "<html><head></head><body><p>Invoked if <code>isHardExpired</code> is false to determine if the request\nshould be update behind the scenes if cache data is already available.</p>\n<p>Note, this is only invoked if the request has a cache-key.</p>\n<p>If true, the request will be fulfilled from cache while a backgrounded\nrequest is made to update the cache via the configured request handlers.</p>\n</body></html>",
52+
"itemtype": "method",
53+
"name": "isSoftExpired",
54+
"access": "public",
55+
"tagname": "",
56+
"params": [
57+
{
58+
"name": "identifier",
59+
"description": "",
60+
"type": "StableDocumentIdentifier"
61+
},
62+
{
63+
"name": "store",
64+
"description": "",
65+
"type": "Store"
66+
}
67+
],
68+
"return": {
69+
"description": "true if the request is considered soft expired",
70+
"type": "Boolean"
71+
},
72+
"class": "<Interface> CachePolicy",
73+
"module": "@ember-data/store"
74+
},
75+
{
76+
"file": "../packages/store/src/-private/cache-handler.ts",
77+
"line": 79,
78+
"description": "<html><head></head><body><p>Invoked when a request will be sent to the configured request handlers.\nThis is invoked for both foreground and background requests.</p>\n<p>Note, this is invoked regardless of whether the request has a cache-key.</p>\n</body></html>",
79+
"itemtype": "method",
80+
"name": "willRequest [Optional]",
81+
"access": "public",
82+
"tagname": "",
83+
"params": [
84+
{
85+
"name": "request",
86+
"description": "",
87+
"type": "ImmutableRequestInfo"
88+
},
89+
{
90+
"name": "identifier",
91+
"description": "",
92+
"type": "StableDocumentIdentifier | null"
93+
},
94+
{
95+
"name": "store",
96+
"description": "",
97+
"type": "Store"
98+
}
99+
],
100+
"return": {
101+
"description": "",
102+
"type": "Void"
103+
},
104+
"class": "<Interface> CachePolicy",
105+
"module": "@ember-data/store"
106+
},
107+
{
108+
"file": "../packages/store/src/-private/cache-handler.ts",
109+
"line": 94,
110+
"description": "<html><head></head><body><p>Invoked when a request has been fulfilled from the configured request handlers.\nThis is invoked for both foreground and background requests once the cache has\nbeen updated.</p>\n<p>Note, this is invoked regardless of whether the request has a cache-key.</p>\n</body></html>",
111+
"itemtype": "method",
112+
"name": "didRequest [Optional]",
113+
"access": "public",
114+
"tagname": "",
115+
"params": [
116+
{
117+
"name": "request",
118+
"description": "",
119+
"type": "ImmutableRequestInfo"
120+
},
121+
{
122+
"name": "response",
123+
"description": "",
124+
"type": "ImmutableResponse"
125+
},
126+
{
127+
"name": "identifier",
128+
"description": "",
129+
"type": "StableDocumentIdentifier | null"
130+
},
131+
{
132+
"name": "store",
133+
"description": "",
134+
"type": "Store"
135+
}
136+
],
137+
"return": {
138+
"description": "",
139+
"type": "Void"
140+
},
141+
"class": "<Interface> CachePolicy",
142+
"module": "@ember-data/store"
143+
}
144+
],
145+
"events": [],
146+
"properties": []
147+
},
148+
"relationships": {
149+
"parent-class": {
150+
"data": null
151+
},
152+
"descendants": {
153+
"data": []
154+
},
155+
"module": {
156+
"data": {
157+
"id": "ember-data-5.3.8-@ember-data/store",
158+
"type": "module"
159+
}
160+
},
161+
"project-version": {
162+
"data": {
163+
"id": "ember-data-5.3.8",
164+
"type": "project-version"
165+
}
166+
}
167+
}
168+
}
169+
}

0 commit comments

Comments
 (0)