jrburke
commented
12 years ago Sorry for the delay in response, we were not getting notifications of new issues. Mentioning @unscriptable so he gets notified too.
In general, most of these signatures are supported, but the API doc is very terse and may not make this clear. I have an action item to expand the API doc with more examples to make it clear. Specific feedback:
define(module value | module factory)
this is supported in the current API definition, as long as "module value" is an object literal. Using an array would confuse it with the dependency list.
define([dependency array of module IDs], module value | module factory)
This is supported today, except if there is a dependency array, then the second arg must be a module factory. Having a module value does not make sense here, since if it is a value it means the module is fully formed without needing dependencies.
define(module ID, [dependency array of module IDs], module value | module factory)
Supported today, with the exception of the "module value" caveat mentioned above.
define({imports}, module value | module factory) [new signature]
You can get this today via the simplified commonjs wrapper:
define(function (require) {
var a = require('a'),
b = require('./b')
});The function is toString()'ed and require calls are parsed out, those dependencies are loaded, then the the factory function is executed. In the requirejs optimizer, this form is transformed to explicitly list the dependencies in an array so no toString() work is done after a build.
In this way require acts like the import object, and it works better with tools like jslint, since getting a local var enables getting warnings of an unused dependency and warning of a missing dependency.
I am going to close this for now, but we can continue discussing it and reopen if there is a need. However, I believe adding an imports construct will add more to the API surface and require as used above gives the same behavior.
dschnare
unscriptable
domenic
See definejs for an example implementation and usage
I'd like to request that the AMD 'define()' have the following signatures:
define(module value | module factory)Defines an anonymous module, extracting its ID from the module's path. If a module factory is specified then the factory is called and the module's value will be equal to its return value.define([dependency array of module IDs], module value | module factory)Defines an anonymous module, extracting its ID from the module's path. If a module factory is specified then the factory is called with the values of each dependent module loaded from the dependency array, and the module's value will be equal to the factory's return value. The module factory will only be called after each dependency has loaded and the dependcies wil be passed to the factory in the same order as the dependency array.define(module ID, [dependency array of module IDs], module value | module factory)Defines a named module, where the specified module ID is used for caching instead of the modules path. If a module factory is specified then the factory is called with the values of each dependent module loaded from the dependency array, and the module's value will be equal to the factory's return value. The module factory will only be called after each dependency has loaded and the dependcies wil be passed to the factory in the same order as the dependency array.define({imports}, module value | module factory)[new signature] Where 'imports' is an object where each key is the name of an import and whose value is a dependent module ID. Defines an anonymous module, extracting its ID from the module's path. If a module factory is specified then the factory is called with an object where each key from the imports object equals the corresponding loaded module. The module's value will be equal to the factory's return value. The module factory will only be called after each dependency has loaded.define(module ID, {imports}, module value | module factory)[new signature] Where 'imports' is an object where each key is the name of an import and whose value is a dependent module ID. Defines named module, where the specified module ID is used for caching instead of the modules path. If a module factory is specified then the factory is called with an object where each key from the imports object equals the corresponding loaded module. The module's value will be equal to the factory's return value. The module factory will only be called after each dependency has loaded.The following signatures are not so import to include, but offer an object-literal technique, so that the arguments are are explicitly named and easier to understand when reading code.
NOTES:
At the very least I'd would love to see the addition of the import object. The advantage of using an import object is that the import name of each module being imported is given at the same location where the dependency is specified and not in the module factory signature. This permits a module factory to have one formal paramter for all imports which much easier to read for modules that have several dependencies.