Javascript.index.mustache Maven / Gradle / Ivy
{{>licenseInfo}}
import ApiClient from './ApiClient';
{{#models}}import {{#model}}{{classFilename}}{{/model}} from './{{#modelPackage}}{{.}}/{{/modelPackage}}{{importPath}}';
{{/models}}{{#apiInfo}}{{#apis}}import {{importPath}} from './{{#apiPackage}}{{.}}/{{/apiPackage}}{{importPath}}';
{{/apis}}{{/apiInfo}}
{{#emitJSDoc}}/**{{#projectDescription}}
* {{.}}.
{{/projectDescription}}
* The index module provides access to constructors for all the classes which comprise the public API.
*
* An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:
*
* var {{moduleName}} = require('{{#invokerPackage}}{{.}}/{{/invokerPackage}}index'); // See note below*.
* var xxxSvc = new {{moduleName}}.XxxApi(); // Allocate the API class we're going to use.
* var yyyModel = new {{moduleName}}.Yyy(); // Construct a model instance.
* yyyModel.someProperty = 'someValue';
* ...
* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
* ...
*
* *NOTE: For a top-level AMD script, use require(['{{#invokerPackage}}{{.}}/{{/invokerPackage}}index'], function(){...})
* and put the application logic within the callback function.
*
*
* A non-AMD browser application (discouraged) might do something like this:
*
* var xxxSvc = new {{moduleName}}.XxxApi(); // Allocate the API class we're going to use.
* var yyy = new {{moduleName}}.Yyy(); // Construct a model instance.
* yyyModel.someProperty = 'someValue';
* ...
* var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
* ...
*
*
* @module {{#invokerPackage}}{{.}}/{{/invokerPackage}}index
* @version {{projectVersion}}
*/{{/emitJSDoc}}
export {
{{=< >=}}
<#emitJSDoc>/**
* The ApiClient constructor.
* @property {module:<#invokerPackage>/ ApiClient}
*/
ApiClient<#models>,
<#emitJSDoc>/**
* The model constructor.
* @property {module:<#invokerPackage>/ <#modelPackage>/ }
*/
<#apiInfo><#apis>,
<#emitJSDoc>/**
* The service constructor.
* @property {module:<#invokerPackage>/ <#apiPackage>/ }
*/
};<={{ }}=>