JSDoc: Erlaubte Werte von Parametern definieren, die den String-Typ haben

Question

Ich benutze JSDoc und ich möchte die Informationen zu meiner Dokumentation hinzufügen, welchen Wert ein Parameter haben sollte. In diesem Beispiel können Sie sehen, dass der Parameter operator String-Typ hat. Aber darüber hinaus kann es nur open oder close als gültige Wert des Parameters

/** 
* Description 
* @param {string='open','close'} operator 
*/ 

Was ist die korrekte Syntax dieser Informationen hinzufügen?

Answer 1

eine Art Vereinigung Verwenden |:

/** 
* Description 
* @param {('open'|'close')} operator 
*/ 

Answer 2

Aus gestalterischen Sicht, wenn Ihr Kinderwagen auf eine Liste von Optionen beschränkt ist, sollten Sie ein Enum diese Optionen für Wiederverwertbarkeit erstellen. sehen Sie diese Antwort für Details: https://stackoverflow.com/a/19322623/5633515

Alternativ können Sie Wrapper-Funktionen wie

_changeState(state){...} // assumed private 
close(){ _changeState('close')} 
open(){_changeState('open')} 

erstellen