EnvironmentOverload
Overload represents the serializable format of a function overload.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EnvironmentOverload(
id,args?,returnType?,target?,examples?):Overload
Constructor returns a new serializable representation of a global or member overload.
Parameters
Section titled “Parameters”string
TypeDesc[] = []
returnType?
Section titled “returnType?”TypeDesc
target?
Section titled “target?”TypeDesc
examples?
Section titled “examples?”string[] = []
Returns
Section titled “Returns”Overload
Properties
Section titled “Properties”args:
TypeDesc[]
examples
Section titled “examples”examples:
string[]
id:
string
return?
Section titled “return?”
optionalreturn?:TypeDesc
target?
Section titled “target?”
optionaltarget?:TypeDesc
Methods
Section titled “Methods”asFunctionOption()
Section titled “asFunctionOption()”asFunctionOption(
tp):OverloadDecl
AsFunctionOption converts the serializable form of the Overload into a function declaration option.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”validate()
Section titled “validate()”validate():
Error|undefined
Validate validates the overload configuration is well-formed.
Returns
Section titled “Returns”Error | undefined