chore: update jsdoc

contentful · Sep 16, 2022 · 9c2e939 · 9c2e939
1 parent 246285d
commit 9c2e939
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/lib/create-contentful-api.js b/lib/create-contentful-api.js
@@ -31,6 +31,15 @@
  * @prop {string} linkType - type of this link. If defined, either Entry or Asset
  */
 
+/**
+ * Link to another entity in a different space.
+ * @memberof Entities
+ * @typedef ResourceLink
+ * @prop {string} type - type of this entity. Always ResourceLink.
+ * @prop {string} urn
+ * @prop {string} linkType - type of this link. Always Contentful:Entry
+ */
+
 /**
  * @memberof ContentfulClientAPI
  * @typedef {Object} ClientAPI

diff --git a/lib/entities/entry.js b/lib/entities/entry.js
@@ -55,7 +55,7 @@ import resolveResponse from 'contentful-resolve-response'
  * A Field in an Entry can have one of the following types that can be defined in Contentful. See <a href="https://www.contentful.com/developers/docs/references/field-type/">Field Types</a> for more details.
  * @memberof Entities
  * @typedef Field
- * @type EntryFields.Symbol | EntryFields.Text | EntryFields.Integer | EntryFields.Number | EntryFields.Date | EntryFields.Boolean | EntryFields.Location | Entities.Link | Array<EntryFields.Symbol|Entities.Link> | Object
+ * @type EntryFields.Symbol | EntryFields.Text | EntryFields.Integer | EntryFields.Number | EntryFields.Date | EntryFields.Boolean | EntryFields.Location | Entities.Link | Entities.ResourceLink | Array<EntryFields.Symbol|Entities.Link|Entities.ResourceLink> | Object
  */
 
 /**