A Cloudevent class per spec version #28

Activity

1. fabiojose

   added

   type/enhancementNew feature or requestNew feature or request

   on Aug 7, 2019
2. fabiojose

   self-assigned this

   on Aug 7, 2019
3. fabiojose

   added

   version/1.xIssues related to version 1.x of this libraryIssues related to version 1.x of this library

   on Aug 8, 2019
4. fabiojose commented on Aug 8, 2019

   

   fabiojose

   on Aug 8, 2019

   ContributorAuthor

   More actions

   @grant What do you think about this definition? May be would be better in ts?

   /*!
    * cloudevents.io
    * Apache-2.0 Licensed
    */
   
   "use strict";
   
   /**
    * CloudEvent prototype
    *
    * @example
    * let event = new CloudEvent("A234-1234-1234", "https://github.com/cloudevents/spec/pull", "com.github.pull.create", {
    *     "comexampleextension1" : "value",
    *     "comexampleextension2" : {
    *         "othervalue" : 5
    *     }
    * });
    *
    * @constructor
    * @class
    * @param {String} id - Identifies the event
    * @param {String} source - Identifies the context in which an event happened
    * @param {String} type - The originating occurrence
    * @param {Object} extensions - Custom additional context attributes
   
    * @param {Object} data - Data attribute
    * @public
    */
   function CloudEvent(id, source, type, extensions, data) {
   
   }
   
   CloudEvent.prototype.data = (data) => {
   
   };
   
   /**
    * Returns the internal representation of context attributes, extension
    * attribute and data attribute.
    *
    * @example
    * let event = new CloudEvent("A234-1234-1234", "https://github.com/cloudevents/spec/pull", "com.github.pull.create");
    * event
    *   .then((payload) => {
    *     // use the event payload, which is valid
    *     payload.id;
    *     payload.source;
    *     payload.specversion;
    *   })
    *   .catch((err) => {
    *     // threat the err reporting an invalid payload
    *   });
    *
    * @return {Promise} To resolve the event as object notation
    * @public
    */
   CloudEvent.prototype.asObject = () => {
   
   };
   
   /**
    * Validates the payload against the definitions, but if something
    * is wrong throws and exception.
    *
    */
   CloudEvent.prototype.validate = () => {
   
   };
   
   module.exports = CloudEvent;
5. grant commented on Aug 8, 2019

   

   grant

   on Aug 8, 2019

   Member

   More actions

   Looks ok.
   Would be much better with modern javascript (class) or TypeScript.
6. fabiojose commented on Aug 8, 2019

   

   fabiojose

   on Aug 8, 2019

   ContributorAuthor

   More actions

   @grant Would like to help us with these definitions?
7. grant commented on Sep 30, 2019

   

   grant

   on Sep 30, 2019

   Member

   More actions

   @fabiojose Sent email to you to discuss more first.
8. lance commented on May 9, 2020

   

   lance

   on May 9, 2020

   Member

   More actions

   Given how the repo has evolved since this issue has been opened, I suggest closing this. @grant @fabiojose WDYT?
9. fabiojose commented on May 9, 2020

   

   fabiojose

   on May 9, 2020

   ContributorAuthor

   More actions

   It's ok for me.
10. lance commented on May 11, 2020

    

    lance

    on May 11, 2020

    Member

    More actions

    @fabiojose OK closing for now - as things progress we may revisit this, or not. :)
11. lance

    closed this as completedon May 11, 2020