@@ -15,17 +15,18 @@ jsonapi-fractal
15
15
- [ JsonApiFractalError] ( classes/JsonApiFractalError.md )
16
16
- [ Transformer] ( classes/Transformer.md )
17
17
18
- ### JSON Type aliases
18
+ ### JSON Type Aliases
19
19
20
20
- [ JsonObject] ( README.md#jsonobject )
21
21
22
- ### Other Type aliases
22
+ ### Other Type Aliases
23
23
24
24
- [ AttributesObject] ( README.md#attributesobject )
25
25
- [ Context] ( README.md#context )
26
26
- [ DocumentObject] ( README.md#documentobject )
27
27
- [ ExistingDocumentObject] ( README.md#existingdocumentobject )
28
28
- [ ExistingResourceObject] ( README.md#existingresourceobject )
29
+ - [ LinkObject] ( README.md#linkobject )
29
30
- [ MetaObject] ( README.md#metaobject )
30
31
- [ NewDocumentObject] ( README.md#newdocumentobject )
31
32
- [ NewResourceObject] ( README.md#newresourceobject )
@@ -45,7 +46,7 @@ jsonapi-fractal
45
46
- [ transform] ( README.md#transform )
46
47
- [ whitelist] ( README.md#whitelist )
47
48
48
- ## JSON Type aliases
49
+ ## JSON Type Aliases
49
50
50
51
### JsonObject
51
52
@@ -61,15 +62,15 @@ node_modules/type-fest/source/basic.d.ts:22
61
62
62
63
___
63
64
64
- ## Other Type aliases
65
+ ## Other Type Aliases
65
66
66
67
### AttributesObject
67
68
68
69
Ƭ ** AttributesObject** : [ ` JsonObject ` ] ( README.md#jsonobject )
69
70
70
71
#### Defined in
71
72
72
- [ src/types.ts:17] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L17 )
73
+ [ src/types.ts:17] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L17 )
73
74
74
75
___
75
76
95
96
96
97
#### Defined in
97
98
98
- [ src/context.ts:5] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/context.ts#L5 )
99
+ [ src/context.ts:5] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/context.ts#L5 )
99
100
100
101
___
101
102
105
106
106
107
#### Defined in
107
108
108
- [ src/types.ts:15] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L15 )
109
+ [ src/types.ts:15] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L15 )
109
110
110
111
___
111
112
@@ -115,17 +116,27 @@ ___
115
116
116
117
#### Defined in
117
118
118
- [ src/types.ts:11] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L11 )
119
+ [ src/types.ts:11] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L11 )
119
120
120
121
___
121
122
122
123
### ExistingResourceObject
123
124
124
- Ƭ ** ExistingResourceObject** : [ ` ResourceIdentifierObject ` ] ( README.md#resourceidentifierobject ) & { ` attributes ` : [ ` AttributesObject ` ] ( README.md#attributesobject ) ; ` id ` : ` string ` ; ` relationships? ` : ` Record ` <` string ` , [ ` RelationshipObject ` ] ( README.md#relationshipobject ) \> }
125
+ Ƭ ** ExistingResourceObject** : [ ` ResourceIdentifierObject ` ] ( README.md#resourceidentifierobject ) & { ` attributes ` : [ ` AttributesObject ` ] ( README.md#attributesobject ) ; ` id ` : ` string ` ; ` links? ` : [ ` LinkObject ` ] ( README.md#linkobject ) ; ` relationships? ` : ` Record ` <` string ` , [ ` RelationshipObject ` ] ( README.md#relationshipobject ) \> }
125
126
126
127
#### Defined in
127
128
128
- [ src/types.ts:26] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab/src/types.ts#L26 )
129
+ [ src/types.ts:28] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L28 )
130
+
131
+ ___
132
+
133
+ ### LinkObject
134
+
135
+ Ƭ ** LinkObject** : [ ` JsonObject ` ] ( README.md#jsonobject )
136
+
137
+ #### Defined in
138
+
139
+ [ src/types.ts:21] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d/src/types.ts#L21 )
129
140
130
141
___
131
142
135
146
136
147
#### Defined in
137
148
138
- [ src/types.ts:19] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L19 )
149
+ [ src/types.ts:19] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L19 )
139
150
140
151
___
141
152
145
156
146
157
#### Defined in
147
158
148
- [ src/types.ts:13] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L13 )
159
+ [ src/types.ts:13] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L13 )
149
160
150
161
___
151
162
155
166
156
167
#### Defined in
157
168
158
- [ src/types.ts:32 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L32 )
169
+ [ src/types.ts:35 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L35 )
159
170
160
171
___
161
172
181
192
182
193
#### Defined in
183
194
184
- [ src/types.ts:46 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L46 )
195
+ [ src/types.ts:50 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L50 )
185
196
186
197
___
187
198
@@ -194,10 +205,11 @@ ___
194
205
| Name | Type |
195
206
| :------ | :------ |
196
207
| ` data ` | [ ` ResourceIdentifierObject ` ] ( README.md#resourceidentifierobject ) \| [ ` ResourceIdentifierObject ` ] ( README.md#resourceidentifierobject ) [ ] |
208
+ | ` links? ` | [ ` LinkObject ` ] ( README.md#linkobject ) |
197
209
198
210
#### Defined in
199
211
200
- [ src/types.ts:36 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L36 )
212
+ [ src/types.ts:39 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L39 )
201
213
202
214
___
203
215
222
234
223
235
#### Defined in
224
236
225
- [ src/transformer.ts:24] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/transformer.ts#L24 )
237
+ [ src/transformer.ts:24] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/transformer.ts#L24 )
226
238
227
239
___
228
240
254
266
255
267
#### Defined in
256
268
257
- [ src/transformer.ts:19] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/transformer.ts#L19 )
269
+ [ src/transformer.ts:19] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/transformer.ts#L19 )
258
270
259
271
___
260
272
271
283
272
284
#### Defined in
273
285
274
- [ src/types.ts:21 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L21 )
286
+ [ src/types.ts:23 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L23 )
275
287
276
288
___
277
289
281
293
282
294
#### Defined in
283
295
284
- [ src/types.ts:34 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L34 )
296
+ [ src/types.ts:37 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L37 )
285
297
286
298
___
287
299
297
309
298
310
#### Defined in
299
311
300
- [ src/types.ts:59 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/types.ts#L59 )
312
+ [ src/types.ts:63 ] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/types.ts#L63 )
301
313
302
314
___
303
315
314
326
315
327
#### Defined in
316
328
317
- [ src/transformer.ts:14] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/transformer.ts#L14 )
329
+ [ src/transformer.ts:14] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/transformer.ts#L14 )
318
330
319
331
## Functions
320
332
@@ -344,7 +356,7 @@ Deserialize a JSON:API response
344
356
345
357
#### Defined in
346
358
347
- [ src/deserializer.ts:12] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/deserializer.ts#L12 )
359
+ [ src/deserializer.ts:12] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/deserializer.ts#L12 )
348
360
349
361
___
350
362
@@ -375,7 +387,7 @@ Serialize the entity
375
387
376
388
#### Defined in
377
389
378
- [ src/serializer.ts:32] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/serializer.ts#L32 )
390
+ [ src/serializer.ts:32] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/serializer.ts#L32 )
379
391
380
392
___
381
393
@@ -398,7 +410,7 @@ Create a ContextBuilder, used to configure the transformation
398
410
399
411
#### Defined in
400
412
401
- [ src/serializer.ts:21] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/serializer.ts#L21 )
413
+ [ src/serializer.ts:21] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/serializer.ts#L21 )
402
414
403
415
___
404
416
@@ -421,4 +433,4 @@ Keep only a set of fields on a given object
421
433
422
434
#### Defined in
423
435
424
- [ src/utils.ts:55] ( https://github.com/andersondanilo/jsonapi-fractal/blob/19282ab /src/utils.ts#L55 )
436
+ [ src/utils.ts:55] ( https://github.com/andersondanilo/jsonapi-fractal/blob/fc0b05d /src/utils.ts#L55 )
0 commit comments