API Docs for: 0.4
Show:

RSAddonYUI Class

Defined in: mojito_src/lib/app/addons/rs/yui.server.js:16
Module: ResourceStoreAddon

Methods

_captureYUIModuleDetails

(
  • res
)
Nothing private

Defined in mojito_src/lib/app/addons/rs/yui.server.js:592

If the resource is a YUI module, augments its metadata with metadata about the YUI module.

Parameters:

  • res Object

    resource metadata

Returns:

Nothing:

_getYUIDependencies

(
  • env
  • poslKey
  • lang
  • module
)
Object private

Defined in mojito_src/lib/app/addons/rs/yui.server.js:541

Returns precomputed dependencies saved by _setYuiSorted.

Parameters:

  • env String

    runtime environment (either client, or server)

  • poslKey String

    key (representing the POSL) under which to save the moduldes

  • lang String

    YUI language code

  • module String

    YUI module name for which the precomputed dependencies are for

Returns:

Object: the precomputed dependencies

_makeYUIModuleConfig

(
  • env
  • res
)
Object private

Defined in mojito_src/lib/app/addons/rs/yui.server.js:575

Generates the YUI configuration for the resource.

Parameters:

  • env String

    runtime environment (either client, or server)

  • res Object

    the resource metadata

Returns:

Object: the YUI configuration for the module

_precomputeYUIDependencies

(
  • lang
  • env
  • mojit
  • modules
  • required
)
Object private

Defined in mojito_src/lib/app/addons/rs/yui.server.js:439

Precomputes a set of dependencies.

Parameters:

  • lang String

    YUI language code

  • env String

    runtime environment (either client, or server)

  • mojit String

    name of the mojit

  • modules Object

    YUI module metadata

  • required Object

    lookup hash of YUI module names that are required

Returns:

Object: precomputed (and sorted) module dependencies

_setYUIDependencies

(
  • env
  • poslKey
  • lang
  • module
  • sorted
)
Nothing private

Defined in mojito_src/lib/app/addons/rs/yui.server.js:516

Saves the precomputed YUI module dependencies for later.

Parameters:

  • env String

    runtime environment (either client, or server)

  • poslKey String

    key (representing the POSL) under which to save the moduldes

  • lang String

    YUI language code

  • module String

    YUI module name for which the precomputed dependencies are for

  • sorted Object

    the precomputed dependencies

Returns:

Nothing:

addResourceVersion

(
  • res
)
Nothing

Defined in mojito_src/lib/app/addons/rs/yui.server.js:231

Using AOP, this is called before the ResourceStore's version. If the resource is a YUI module, augments the metadata with details about the YUI module.

Parameters:

  • res Object

    resource version metadata

Returns:

Nothing:

findResourceVersionByConvention

(
  • source
  • mojitType
)
Object | | Null

Defined in mojito_src/lib/app/addons/rs/yui.server.js:134

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 yui modules or lang bundles, returns metadata signifying that

getConfigAllMojits

(
  • env
  • ctx
)
Object

Defined in mojito_src/lib/app/addons/rs/yui.server.js:97

Returns a datastructure which tells a YUI instance where to find the YUI modules that are in all the mojits.

Parameters:

  • env String

    runtime environment (either client, or server)

  • ctx Object

    runtime context

Returns:

Object: datastructure for configuring YUI

getConfigShared

(
  • env
  • ctx
  • justApp
)
Object

Defined in mojito_src/lib/app/addons/rs/yui.server.js:66

Returns a datastructure which tells a YUI instance where to find the YUI modules that are shared among all mojits.

Parameters:

  • env String

    runtime environment (either client, or server)

  • ctx Object

    runtime context

  • justApp Boolean

    Indicates whether to include the YUI modules just found in the application (true), or also include those found in mojito (false).

Returns:

Object: datastructure for configuring YUI

initializer

(
  • config
)
Nothing

Defined in mojito_src/lib/app/addons/rs/yui.server.js:39

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:

onGetMojitTypeDetails

(
  • evt
)
Nothing

Defined in mojito_src/lib/app/addons/rs/yui.server.js:258

This is called when the ResourceStore fires this event. It augments the mojit type details with the precomputed YUI module dependencies.

Parameters:

  • evt Object

    The fired event.

Returns:

Nothing:

onMojitResourcesResolved

(
  • evt
)
Nothing

Defined in mojito_src/lib/app/addons/rs/yui.server.js:318

This is called when the ResourceStore fires this event. It precomputes the YUI module dependencies, to be used later during onGetMojitTypeDetails.

Parameters:

  • evt Object

    The fired event

Returns:

Nothing:

parseResourceVersion

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

Defined in mojito_src/lib/app/addons/rs/yui.server.js:167

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 yui modules or lang bundles, returns the resource metadata