Global

Members

(constant) ONE :number

Type:
  • number
Source:

(constant) RED :string

Type:
  • string
Default Value:
  • FF0000
Source:

foo

Source:

(readonly) triState :number

Enum for tri-state values.

Type:
  • number
Properties:
Name Type Description
TRUE number

The true value
FALSE number
MAYBE boolean
Source:

Methods

Thingy2()

Author:
Source:

UserRecord()

Provides access to user information.

Since:
  • 1.0.1
Source:

add(a, b) → {number}

Add two numbers.

Parameters:
Name Type Description
a number
b number
Source:
Returns:
Type
number

bar()

Deprecated:
  • since version 2.0
Source:

bar()

Source:
See:

clean(dispenser, cleaner)

Inline type info for trailing param only.

Parameters:
Name Type Description
dispenser Dispenser
cleaner string
Source:

dispense(candy)

Inline type info only.

Parameters:
Name Type Description
candy string
Source:

doSomethingAsynchronously(cb)

Does something asynchronously and executes the callback on completion.

Parameters:
Name Type Description
cb requestCallback

The callback that handles the response.
Source:

(async) downloadData(url) → {Promise.<string>}

Download data from the specified URL.

Parameters:
Name Type Description
url string

The URL to download from.
Source:
Returns:

The data from the URL.

Type
Promise.<string>

foo()

Deprecated:
  • Yes
Source:

foo()

Both of these will link to the bar function.

Source:
See:

myFunction()

Source:

myFunction()

Source:

paginate()

Source:

paint(dispenser, color, shade, brand)

Inline type info for inner param only.

Parameters:
Name Type Description
dispenser Dispenser
color Color
shade number
brand string
Source:

restock(dispenser, item)

Inline type info for leading param only.

Parameters:
Name Type Description
dispenser Dispenser
item string
Source:

sayHello(somebodyopt)

Parameters:
Name Type Attributes Description
somebody string <optional>

Somebody's name.
Source:

sayHelloo(somebodyopt)

Parameters:
Name Type Attributes Default Description
somebody string | Array.<string> <optional>
 John Doe

Somebody's name, or an array of names.
Source:

setMagicNumber(x)

Set the magic number.

Parameters:
Name Type Description
x NumberLike

The magic number.
Source:

sum(a, b) → {number}

Returns the sum of a and b

Parameters:
Name Type Description
a number
b number
Source:
Returns:
Type
number

sumAsync(a, b) → {Promise}

Returns the sum of a and b

Parameters:
Name Type Description
a number
b number
Source:
Returns:

Promise object represents the sum of a and b

Type
Promise

summ(a, b, retArr) → {number|Array}

Returns the sum of a and b

Parameters:
Name Type Description
a number
b number
retArr boolean

If set to true, the function will return an array
Source:
Returns:

Sum of a and b or an array that contains a, b and the sum of a and b.

Type
number | Array

trstr(str)

Remove whitespace from around a string.

Parameters:
Name Type Description
str string
Source:

Type Definitions

NumberLike

A number, or a string containing a number.

Type:
  • number | string
Source:

User

User type definition

Type:
  • Object
Properties:
Name Type Attributes Description
email string
nickName string <optional>
Source:

requestCallback(responseCode, responseMessage)

This callback is displayed as a global member.

Parameters:
Name Type Description
responseCode number
responseMessage string
Source:

requestCallback(responseCode, responseMessage)

This callback type is called requestCallback and is displayed as a global symbol.

Parameters:
Name Type Description
responseCode number
responseMessage string
Source:

Table of contents