Wie dokumentieren die „setState“ Funktion

Question

Ausgabe

Ich versuche, mit JSdoc Ereignisse zu dokumentieren. Hier ist die example Ich folgte:

/** 
* Throw a snowball. 
* 
* @fires Hurl#snowball 
*/ 
Hurl.prototype.snowball = function() { 
    /** 
    * Snowball event. 
    * 
    * @event Hurl#snowball 
    * @type {object} 
    * @property {boolean} isPacked - Indicates whether the snowball is tightly packed. 
    */ 
    this.emit('snowball', { 
     isPacked: this._snowball.isPacked 
    }); 
};  

Nach diesem Beispiel dokumentiert ich meine Ereignisse wie folgt.

Inside a class named "Something" 
/** 
    Update state to include entered Thing Name 
    @fires Something#handleThingChange 
*/ 
    handleThingChange = (evt) => { 
    /** 
     handleThingChange event. 

     @event Something#handleThingChange 
     @type {updater} 
     @property {string} state.thing 
    */ 
    this.setState({ thing: evt.target.value }); 
    } 

Frage

Ich bin nicht sicher, wie die setState Funktion zu dokumentieren. Ist es vom Typ updater? Oder garantiert es das @callback Tag?

Answer 1

Basierend auf Ihrem Code würde ich sagen, dass es vom Typ updater sein wird.

Erklärung

Die ReactComponent.setState „Updates“ die aktuelle Komponente Zustand, so wäre es sinnvoll sein, sie als solche zu dokumentieren. Ja, die Methode hat einen optionalen callback Parameter, aber ich würde das nicht berücksichtigen, weil Sie es nicht verwenden.