API Docs for: 0.7.0
Show:

Params.common Class

Defined in: node_modules/mojito/lib/app/addons/ac/params.common.js:18
Module: ActionContextAddon

Access point: ac.params.* Addon that provides access to any parameters given to the system

Methods

all

() Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:52

Alias for 'getAll'.

Returns:

Object: all params.

body

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:187

Alias for 'getFromBody'.

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.

getAll

() Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:36

Gets all params, keyed by 'route', 'url', 'body', and 'file'.

Returns:

Object: all params.

getFromBody

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:166

Gets body parameters

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.

getFromMerged

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:62

Gets all params merged into one object. Route -> URL -> Body precedence.

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.

getFromRoute

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:100

Gets route parameters

Parameters:

  • key String

    The name of the parameter.

Returns:

String | Object: param value, or all params if no key specified.

getFromUrl

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:133

Gets URL parameters

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.

merged

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:88

Alias for 'getFromMerged'.

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.

route

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:121

Alias for 'getFromRoute'.

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.

url

(
  • key
)
String | Object

Defined in node_modules/mojito/lib/app/addons/ac/params.common.js:154

Alias for 'getFromUrl'.

Parameters:

  • key String

    The name of the parameter required.

Returns:

String | Object: param value, or all params if no key specified.