This function destructures with defaults. It should not have any parameter descriptions.
Parameters
Parameter | Description |
---|---|
$0 Object |
(optional, default {} ) |
:---------------------- | ------------------------- |
$0.phoneNumbers |
(optional, default [] ) |
$0.emailAddresses |
(optional, default [] ) |
$0.params ...Any |
|
$0.phoneNumbers |
(optional, default [] ) |
$0.emailAddresses |
(optional, default [] ) |
$0.params ...Any |
Similar, but with an array
Parameters
Parameter | Description |
---|---|
$0 Array |
|
:-------- | ----------- |
$0.a |
|
$0.b |
|
$0.c |
|
$0.a |
|
$0.b |
|
$0.c |
Examples
destructure([1, 2, 3])
This function returns the number one.
Parameters
Parameter | Description |
---|---|
a Array<Number> |
an array of numbers |
b |
Returns Number numberone
This is a sink
This is a property of the sink.
Is it empty
This is a getter method: it should be documented as a property.
Parameters
Parameter | Description |
---|---|
height number |
the height of the thing |
width number |
the width of the thing |
This method says hello
This method returns a basket. The type should not be linked.
Returns Basket a basket
This method returns a sink. The type should be linked. It takes a number which should also be linked.
Returns Sink a sink
This function takes rest params
Parameters
Parameter | Description |
---|---|
someParams ...Any |
So does this one, with types
Parameters
Parameter | Description |
---|---|
someParams ...number |
This is an async method
Parameters
Parameter | Description |
---|---|
thisIsTheArgument |
This function returns the number one.
Returns Number numberone
This tests our support of optional parameters in ES6
Parameters
Parameter | Description |
---|---|
foo |
(optional, default 'bar' ) |
A protected function
A public function
This is re-exported