goog.module.Loader

Provided By	`goog.module.Loader`

The dynamic loading functionality is defined as a class. The class will be used as singleton. There is, however, a two step initialization procedure because parameters need to be passed to the goog.module.Loader instance.

new Loader()

Parameters	None.

VIEW SOURCE

Instance Methods

Initializes the Loader to be fully functional. Also executes load requests that were received before initialization. Must be called exactly once, with the URL of the base library. Module URLs are derived from the URL of the base library by inserting the module name, preceded by a period, before the .js prefix of the base URL.

Parameters

`baseUrl`	`string`
	The URL of the base library.
`opt_urlFunction`	`(Function\|null)=`
	Function that creates the URL for the module file. It will be passed the base URL for module files and the module name and should return the fully-formed URL to the module file to load.

VIEW SOURCE

Registers a symbol in a loaded module. When called without symbol, registers the module to be fully loaded and executes all callbacks from pending require() callbacks for this module.

Parameters

`module`	`string`
	The name of the module. Cf. parameter module of method require().
`opt_symbol`	`(number\|string)=`
	The symbol being defined, or nothing when all symbols of the module are defined. Cf. parameter symbol of method require().
`opt_object`	`(Object\|null)=`
	The object bound to the symbol, or nothing when all symbols of the module are defined.

VIEW SOURCE

Requests the loading of a symbol from a module. When the module is loaded, the requested symbol will be passed as argument to the function callback.

Parameters

`module`	`string`
	The name of the module. Usually, the value is defined as a constant whose name starts with MOD_.
`symbol`	`(number\|string)`
	The ID of the symbol. Usually, the value is defined as a constant whose name starts with SYM_.
`callback`	`(Function\|null)`
	This function will be called with the resolved symbol as the argument once the module is loaded.

VIEW SOURCE

Static Functions

Parameters

None.

Returns

goog.module.Loader

VIEW SOURCE

Wrapper of init() so that we only need to export this single identifier instead of three. See method goog.module.Loader.init() for explanation of param.

Parameters

`urlBase`	`string`
	The URL of the base library.
`opt_urlFunction`	`(Function\|null)=`
	Function that creates the URL for the module file. It will be passed the base URL for module files and the module name and should return the fully-formed URL to the module file to load.

VIEW SOURCE

Produces a function that delegates all its arguments to a dynamically loaded function. This is used to export dynamically loaded functions.

Parameters

`module`	`string`
	The module to load from.
`symbol`	`(number\|string)`
	The ID of the symbol to load from the module. This symbol must resolve to a function.

Returns

Function

A function that forwards all its arguments to the dynamically loaded function specified by module and symbol.

VIEW SOURCE

Wrapper of goog.module.Loader.provide() for use in modules See method goog.module.Loader.provide() for explanation of params.

Parameters

`module`	`string`
	The name of the module. Cf. parameter module of method require().
`opt_symbol`	`(number\|string)=`
	The symbol being defined, or nothing when all symbols of the module are defined. Cf. parameter symbol of method require().
`opt_object`	`(Object\|null)=`
	The object bound to the symbol, or nothing when all symbols of the module are defined.

VIEW SOURCE

Wrapper of goog.module.Loader.require() for use in modules. See method goog.module.Loader.require() for explanation of params.

Parameters

`module`	`string`
	The name of the module. Usually, the value is defined as a constant whose name starts with MOD_.
`symbol`	`(number\|string)`
	The ID of the symbol. Usually, the value is defined as a constant whose name starts with SYM_.
`callback`	`(Function\|null)`
	This function will be called with the resolved symbol as the argument once the module is loaded.

VIEW SOURCE

Static Properties

The globally exported name of the load callback. Matches the definition in the js_module_binary() BUILD rule.

VIEW SOURCE

goog.module.Loader

new Loader()

Instance Methods

`this.`init( `baseUrl`, `opt_urlFunction` ) `→` `void`

`this.`provide( `module`, `opt_symbol`, `opt_object` ) `→` `void`

`this.`require( `module`, `symbol`, `callback` ) `→` `void`

Static Functions

Loader.getInstance() `→` `goog.module.Loader`

Loader.init( `urlBase`, `opt_urlFunction` ) `→` `void`

Loader.loaderCall( `module`, `symbol` ) `→` `Function`

Loader.provide( `module`, `opt_symbol`, `opt_object` ) `→` `void`

Loader.require( `module`, `symbol`, `callback` ) `→` `void`

Static Properties

Loader.LOAD_CALLBACK `→` `string`

goog.module.Loader

new Loader()

Instance Methods

this.init( baseUrl, opt_urlFunction ) → void

this.provide( module, opt_symbol, opt_object ) → void

this.require( module, symbol, callback ) → void

Static Functions

Loader.getInstance() → goog.module.Loader

Loader.init( urlBase, opt_urlFunction ) → void

Loader.loaderCall( module, symbol ) → Function

Loader.provide( module, opt_symbol, opt_object ) → void

Loader.require( module, symbol, callback ) → void

Static Properties

Loader.LOAD_CALLBACK → string

`this.`init( `baseUrl`, `opt_urlFunction` ) `→` `void`

`this.`provide( `module`, `opt_symbol`, `opt_object` ) `→` `void`

`this.`require( `module`, `symbol`, `callback` ) `→` `void`

Loader.getInstance() `→` `goog.module.Loader`

Loader.init( `urlBase`, `opt_urlFunction` ) `→` `void`

Loader.loaderCall( `module`, `symbol` ) `→` `Function`

Loader.provide( `module`, `opt_symbol`, `opt_object` ) `→` `void`

Loader.require( `module`, `symbol`, `callback` ) `→` `void`

Loader.LOAD_CALLBACK `→` `string`