desc of core If '@examples' is a file, all examples will be loaded from there:
Example
Core setup
core.reset()Methods
(inner) addCore(num) → {number}
If '@examples' ends in .js, it's assumed to contain examples for this function
Examples
/*
* all lines of the function body proper (including comments like
* this, and any lines of code) will show up in the documentation,
* except for lines ending in: '// skip'
*/
const result = core.addCore(2)
// <= 2// This is a simple example:
core.addCore(1)core.addCore(2)Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
num |
number |
1
|
Returns:
zero
- Type
- number
(inner) numCores() → {number}
ns desc
Example
a superfluous caption
const result = core.numCores()Returns:
number of cores
- Type
- number
(inner) reset()
No examples yet...