@@ -15,17 +15,18 @@ jsonapi-fractal
1515-  [ JsonApiFractalError] ( classes/JsonApiFractalError.md ) 
1616-  [ Transformer] ( classes/Transformer.md ) 
1717
18- ### JSON Type aliases   
18+ ### JSON Type Aliases   
1919
2020-  [ JsonObject] ( README.md#jsonobject ) 
2121
22- ### Other Type aliases   
22+ ### Other Type Aliases   
2323
2424-  [ AttributesObject] ( README.md#attributesobject ) 
2525-  [ Context] ( README.md#context ) 
2626-  [ DocumentObject] ( README.md#documentobject ) 
2727-  [ ExistingDocumentObject] ( README.md#existingdocumentobject ) 
2828-  [ ExistingResourceObject] ( README.md#existingresourceobject ) 
29+ -  [ LinkObject] ( README.md#linkobject ) 
2930-  [ MetaObject] ( README.md#metaobject ) 
3031-  [ NewDocumentObject] ( README.md#newdocumentobject ) 
3132-  [ NewResourceObject] ( README.md#newresourceobject ) 
@@ -45,7 +46,7 @@ jsonapi-fractal
4546-  [ transform] ( README.md#transform ) 
4647-  [ whitelist] ( README.md#whitelist ) 
4748
48- ## JSON Type aliases   
49+ ## JSON Type Aliases   
4950
5051### JsonObject  
5152
@@ -61,15 +62,15 @@ node_modules/type-fest/source/basic.d.ts:22
6162
6263___ 
6364
64- ## Other Type aliases   
65+ ## Other Type Aliases   
6566
6667### AttributesObject  
6768
6869Ƭ ** AttributesObject** : [ ` JsonObject ` ] ( README.md#jsonobject ) 
6970
7071#### Defined in  
7172
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 ) 
7374
7475___ 
7576
9596
9697#### Defined in  
9798
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 ) 
99100
100101___ 
101102
105106
106107#### Defined in  
107108
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 ) 
109110
110111___ 
111112
@@ -115,17 +116,27 @@ ___
115116
116117#### Defined in  
117118
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 ) 
119120
120121___ 
121122
122123### ExistingResourceObject  
123124
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 ) \>   }
125126
126127#### Defined in  
127128
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 ) 
129140
130141___ 
131142
135146
136147#### Defined in  
137148
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 ) 
139150
140151___ 
141152
145156
146157#### Defined in  
147158
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 ) 
149160
150161___ 
151162
155166
156167#### Defined in  
157168
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  ) 
159170
160171___ 
161172
181192
182193#### Defined in  
183194
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  ) 
185196
186197___ 
187198
@@ -194,10 +205,11 @@ ___
194205|  Name |  Type | 
195206|  :------ |  :------ | 
196207|  ` data `  |  [ ` ResourceIdentifierObject ` ] ( README.md#resourceidentifierobject )  \|  [ ` ResourceIdentifierObject ` ] ( README.md#resourceidentifierobject ) [ ]  | 
208+ |  ` links? `  |  [ ` LinkObject ` ] ( README.md#linkobject )  | 
197209
198210#### Defined in  
199211
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  ) 
201213
202214___ 
203215
222234
223235#### Defined in  
224236
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 ) 
226238
227239___ 
228240
254266
255267#### Defined in  
256268
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 ) 
258270
259271___ 
260272
271283
272284#### Defined in  
273285
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  ) 
275287
276288___ 
277289
281293
282294#### Defined in  
283295
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  ) 
285297
286298___ 
287299
297309
298310#### Defined in  
299311
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  ) 
301313
302314___ 
303315
314326
315327#### Defined in  
316328
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 ) 
318330
319331## Functions  
320332
@@ -344,7 +356,7 @@ Deserialize a JSON:API response
344356
345357#### Defined in  
346358
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 ) 
348360
349361___ 
350362
@@ -375,7 +387,7 @@ Serialize the entity
375387
376388#### Defined in  
377389
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 ) 
379391
380392___ 
381393
@@ -398,7 +410,7 @@ Create a ContextBuilder, used to configure the transformation
398410
399411#### Defined in  
400412
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 ) 
402414
403415___ 
404416
@@ -421,4 +433,4 @@ Keep only a set of fields on a given object
421433
422434#### Defined in  
423435
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