squash: add jsdoc to the cloneWith function

lholmquist · lholmquist · commit c20a10f5ad6e · 2020-07-06T18:47:11.000-04:00
Signed-off-by: Lucas Holmquist &lt;lholmqui@redhat.com&gt;
diff --git a/src/event/cloudevent.ts b/src/event/cloudevent.ts
@@ -170,6 +170,12 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {
     }
   }
 
+  /**
+   * Clone a CloudEvent with new/update attributes
+   * @param {object} options attributes to augment the CloudEvent with
+   * @throws if the CloudEvent does not conform to the schema
+   * @return {CloudEvent} returns a new CloudEvent
+   */
   public cloneWith(
     options:
       | CloudEventV1

Original file line number	Diff line number	Diff line change
`@@ -170,6 +170,12 @@ export class CloudEvent implements CloudEventV1, CloudEventV03 {`
`170`	`170`	`}`
`171`	`171`	`}`
`172`	`172`
	`173`	`+ /**`
	`174`	`+ * Clone a CloudEvent with new/update attributes`
	`175`	`+ * @param {object} options attributes to augment the CloudEvent with`
	`176`	`+ * @throws if the CloudEvent does not conform to the schema`
	`177`	`+ * @return {CloudEvent} returns a new CloudEvent`
	`178`	`+ */`
`173`	`179`	`public cloneWith(`
`174`	`180`	`options:`
`175`	`181`	`\| CloudEventV1`