API Docs for: 0.4
Show:

RSAddonConfig Class

Defined in: mojito_src/lib/app/addons/rs/config.server.js:19
Module: ResourceStoreAddon

Methods

_readYcbDimensions

() Array private

Defined in mojito_src/lib/app/addons/rs/config.server.js:208

Read the application's dimensions.json file for YCB processing. If not available, fall back to the framework's default dimensions.json.

Returns:

Array: contents of the dimensions.json file

findResourceVersionByConvention

(
  • source
  • mojitType
)
Object | | Null

Defined in mojito_src/lib/app/addons/rs/config.server.js:126

Using AOP, this is called after the ResourceStore's version.

Parameters:

  • source Object

    metadata about where the resource is located

  • mojitType String

    name of mojit to which the resource likely belongs

Returns:

Object | | Null: for config file resources, returns metadata signifying that

getDimensions

() Object

Defined in mojito_src/lib/app/addons/rs/config.server.js:55

Returns the YCB dimensions for the application.

Returns:

Object: the YCB dimensions structure for the app

initializer

(
  • config
)
Nothing

Defined in mojito_src/lib/app/addons/rs/config.server.js:37

This methods is part of Y.Plugin.Base. See documentation for that for details.

Parameters:

  • config Object

    Configuration object as per Y.Plugin.Base

Returns:

Nothing:

parseResourceVersion

(
  • source
  • type
  • subtype
  • mojitType
)
Object | | Null

Defined in mojito_src/lib/app/addons/rs/config.server.js:171

Using AOP, this is called before the ResourceStore's version.

Parameters:

  • source Object

    metadata about where the resource is located

  • type String

    type of the resource

  • subtype String

    subtype of the resource

  • mojitType String

    name of mojit to which the resource likely belongs

Returns:

Object | | Null: for config file resources, returns the resource metadata

readConfigJSON

(
  • fullPath
)
User-defined

Defined in mojito_src/lib/app/addons/rs/config.server.js:65

Reads and parses a JSON file.

Parameters:

  • fullPath String

    path to JSON file

Returns:

User-defined: contents of JSON file

readConfigYCB

(
  • ctx
  • fullPath
)
Object

Defined in mojito_src/lib/app/addons/rs/config.server.js:92

Reads a configuration file that is in YCB format.

Parameters:

  • ctx Object

    runtime context

  • fullPath String

    path to the YCB file

Returns:

Object: the contextualized configuration