springroll.DebugOptions Class

Module: Debug

Class for display a list of query string options nicely in the console.

Methods

add

(
  • label
  • type
  • [desc]
)
springroll.DebugOptions
static

Defined in add:133

Define a number query parameter

Parameters:

  • label String

    The label for the options

  • type String

    The type of value the option accepts

  • [desc] String optional

    Description of values the option can accept

Returns:

springroll.DebugOptions:

instance of this DebugOptions for chaining

boolean

(
  • label
  • desc
)
springroll.DebugOptions
static

Defined in boolean:94

Define a boolean query parameter

Parameters:

  • label String

    The label for the options

  • desc String

    Description of values the option can accept

Returns:

springroll.DebugOptions:

instance of this DebugOptions for chaining

int

(
  • label
  • desc
)
springroll.DebugOptions
static

Defined in int:81

Define a int query parameter.

Parameters:

  • label String

    The label for the options

  • desc String

    Description of values the option can accept

Returns:

springroll.DebugOptions:

instance of this DebugOptions for chaining

log

()
static

Defined in log:155

Build the log and final argument array for the options output console.log();

number

(
  • label
  • desc
)
springroll.DebugOptions
static

Defined in number:120

Define a number query parameter

Parameters:

  • label String

    The label for the options

  • desc String

    Description of values the option can accept

Returns:

springroll.DebugOptions:

instance of this DebugOptions for chaining

reset

() springroll.DebugOptions
static

Defined in reset:220

Forget all the options that have been remembered

Returns:

springroll.DebugOptions:

instance of this DebugOptions for chaining

spacer

(
  • count
  • str
)
String
private

Defined in spacer:235

Generate a spacer slug. Returned object is concatenated space character, i.e. ' ', to the specified count.

Parameters:

  • count Int

    How many characters the spacer needs

  • str String

    The input string to add spaces to

Returns:

string

(
  • label
  • desc
)
springroll.DebugOptions
static

Defined in string:107

Define a string query parameter

Parameters:

  • label String

    The label for the options

  • desc String

    Description of values the option can accept

Returns:

springroll.DebugOptions:

instance of this DebugOptions for chaining

_maxLabel

Array private

Defined in _maxLabel:30

The maximum length of the label column

_maxType

Array private

Defined in _maxType:37

The maximum length of the type column

_options

Array private

Defined in _options:23

The collections of options

COLUMN_BUFFER

Int private final

Defined in COLUMN_BUFFER:14

The space between columns

CSS

Object private final

Defined in CSS:44

Config object for the CSS styles throughout

HEADER

String private final

Defined in HEADER:58

The header for the final log

TYPES

String private final

Defined in TYPES:67

The map of different basic types of options.