API Docs for: 0.3
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:48

Alias for 'getAll'.

Returns:

Object: all params.

body

(
  • key
)
String | Object

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

Alias for 'getFromBody'.

Parameters:

  • key String

    The name of the parameter required.

Returns:

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

files

(
  • key
)
String | Object

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

Alias for 'getFromFiles'.

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:32

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:162

Gets body parameters

Parameters:

  • key String

    The name of the parameter required.

Returns:

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

getFromFiles

(
  • key
)
String | Object private

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

Gets file 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:58

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:96

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:129

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:84

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:117

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:150

Alias for 'getFromUrl'.

Parameters:

  • key String

    The name of the parameter required.

Returns:

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