Fix type ResourceObject.

Missing "links".
masterT · Feb 25, 2022 · b62474f · b62474f
1 parent 064c918
commit b62474f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/src/JsonApi/Specification.TypeGuards.ts b/src/JsonApi/Specification.TypeGuards.ts
@@ -365,7 +365,9 @@ export function isResourceObject(obj: any, _argumentName?: string): obj is Resou
         (typeof obj.attributes === "undefined" ||
             isAttributesObject(obj.attributes) as boolean) &&
         (typeof obj.relationships === "undefined" ||
-            isRelationshipsObject(obj.relationships) as boolean)
+            isRelationshipsObject(obj.relationships) as boolean) &&
+        (typeof obj.links === "undefined" ||
+            isLinkObject(obj.links) as boolean)
     )
 }
 

diff --git a/src/JsonApi/Specification.ts b/src/JsonApi/Specification.ts
@@ -245,16 +245,20 @@ export type RelationshipsObject = {
  *           },
  *           "data": { "type": "people", "id": "9" }
  *         }
+ *       },
+ *       "links": {
+ *         "self": "http://example.com/articles/1"
  *       }
  *     }
- * @see {@link https://jsonapi.org/format/#document-links}
+ * @see {@link https://jsonapi.org/format/#document-resource-objects}
  * @see {@link isResourceObject} ts-auto-guard:type-guard
  */
 export type ResourceObject = {
   id: string;
   type: string;
   attributes?: AttributesObject;
   relationships?: RelationshipsObject;
+  links?: LinkObject;
 };
 
 /**