Adding docs to custom Jokers

lib-monkey · Nov 4, 2017 · e67776b · e67776b
1 parent 05d8070
commit e67776b
Show file tree

Hide file tree

Showing 2 changed files with 117 additions and 1 deletion.
diff --git a/index.js b/index.js
@@ -10,6 +10,7 @@ monkey.RunnerCreator.create(lm);
 
 /**
  * Lib-Monky.
+ * @module lib-monkey
  * @autor Team of Monkeys
  * @property {Jokers.BooleanJoker} bool - return instance of the BooleanJoker
  * @property {Jokers.CharJoker} char - return instance of the CharJoker
@@ -23,5 +24,10 @@ monkey.RunnerCreator.create(lm);
  * @property {Jokers.HammertimeJoker} hammertime - return instance of the HammertimeJoker
  * @property {Jokers.TimestampJoker} timestamp - return instance of the TimestampJoker
  * @property {Jokers.TimezoneJoker} timezone - return instance of the TimezoneJoker
+ * @property {Jokers.PickJoker} pick - return instance of the PickJoker
+ * @property {Jokers.ArrayJoker} array - return instance of the ArrayJoker
+ * @property {Jokers.MapJoker} map - return instance of the MapJoker
+ * @property {Jokers.ObjectJoker} object - return instance of the ObjectJoker
+ * @property {Jokers.TypedJoker} typed - return instance of the TypedJocker
  */
 module.exports = lm;
diff --git a/lib/jokers/multi.js b/lib/jokers/multi.js
@@ -1,6 +1,20 @@
 
 import Joker from '../common/joker';
 
+/**
+ * Pick Joker, Picks at random from an array
+ * @class Jokers.PickJoker
+ * @extends Joker
+ * @inheritdoc
+ */
+ /**
+ * @name Jokers.PickJoker#of
+ * @function
+ * @memberof Jokers.PickJoker
+ * @description The Array to pick from
+ * @param {any[]} value
+ * @returns {Joker} self
+ */
 export class PickJoker extends Joker {
 
   static get name(){ return 'pick'; }
@@ -20,6 +34,36 @@ export class PickJoker extends Joker {
 
 }
 
+/**
+ * Array Joker, Creates array from template or description
+ * @class Jokers.ArrayJoker
+ * @extends Joker
+ * @inheritdoc
+ */
+ /**
+ * @name Jokers.ArrayJoker#count
+ * @function
+ * @memberof Jokers.ArrayJoker
+ * @description Set lenght of the array
+ * @param {number} value
+ * @returns {Joker} self
+ */ 
+ /**
+ * @name Jokers.ArrayJoker#of
+ * @function
+ * @memberof Jokers.ArrayJoker
+ * @description The value with what to fill the array (if joker passed it will be extracted)
+ * @param {any} value
+ * @returns {Joker} self
+ */
+ /**
+ * @name Jokers.ArrayJoker#from
+ * @function
+ * @memberof Jokers.ArrayJoker
+ * @description Create array from a pre-determened structure
+ * @param {any[]} value
+ * @returns {Joker} self
+ */
 export class ArrayJoker extends Joker {
 
   static get name() { return 'array'; }
@@ -44,6 +88,20 @@ export class ArrayJoker extends Joker {
 
 }
 
+/**
+ * Map Joker, Creates a map from template
+ * @class Jokers.MapJoker
+ * @extends Joker
+ * @inheritdoc
+ */
+ /**
+ * @name Jokers.MapJoker#of
+ * @function
+ * @memberof Jokers.MapJoker
+ * @description Template for the map
+ * @param {any[]} value
+ * @returns {Joker} self
+ */
 export class MapJoker extends Joker {
 
   static get name() { return 'map'; }
@@ -69,6 +127,20 @@ export class MapJoker extends Joker {
 
 }
 
+/**
+ * Object Joker, Like the Map but recurcive. (Caution may get into an infinite loop haha)
+ * @class Jokers.ObjectJoker
+ * @extends Joker
+ * @inheritdoc
+ */
+ /**
+ * @name Jokers.ObjectJoker#of
+ * @function
+ * @memberof Jokers.ObjectJoker
+ * @description Template for the Object
+ * @param {any[]} value
+ * @returns {Joker} self
+ */
 export class ObjectJoker extends Joker {
 
   static get name() { return 'object'; }
@@ -103,7 +175,45 @@ export class ObjectJoker extends Joker {
   }
 }
 
-export class TypedJocker extends Joker {
+/**
+ * Typed Joker, Creates Specific type
+ * @class Jokers.TypedJoker
+ * @extends Joker
+ * @inheritdoc
+ */
+ /**
+ * @name Jokers.TypedJoker#of
+ * @function
+ * @memberof Jokers.TypedJoker
+ * @description Type to create
+ * @param {type} value
+ * @returns {Joker} self
+ */
+ /**
+ * @name Jokers.TypedJoker#params
+ * @function
+ * @memberof Jokers.TypedJoker
+ * @description Params to pass the Type's constructor
+ * @param {type} value
+ * @returns {Joker} self
+ */
+ /**
+ * @name Jokers.TypedJoker#init
+ * @function
+ * @memberof Jokers.TypedJoker
+ * @description Init function if needed, currently syncronus
+ * @param {type} value
+ * @returns {Joker} self
+ */
+ /**
+ * @name Jokers.TypedJoker#initWith
+ * @function
+ * @memberof Jokers.TypedJoker
+ * @description Params to pass the init function
+ * @param {type} value
+ * @returns {Joker} self
+ */
+export class TypedJoker extends Joker {
 
   static get name() { return 'typed'; }