alezanai / kvs-parser

Kinesis Video Stream Parser Library in Node.js
GNU General Public License v3.0
3 stars 1 forks source link

Set up an empty function diocumented with js doc #2

Closed piercus closed 2 years ago

piercus commented 2 years ago

@dharmik-dalwadi-seaflux please work on the following

Please start a new branch DHA-jsdoc, in order to set up the documentation of your function using jsdoc in kvs-stream.js

For now you will to document the following :

The documentation should explain clearly the signature of the library, you can use the README.md and your current understanding to write it down

dharmik-dalwadi-seaflux commented 2 years ago

@piercus For define the Data event I am confused that it would be just a normal function or we need to use the EventEmitter to emit the data event? Can you please explain or share any references?

piercus commented 2 years ago

EventEmitter makes sense for me, but you could also do with a Transform stream

Anyway, this is no time for implementation yet, so this question is not for now. Currently i'm just asking youto write jsdoc