## Generator **Kind**: global class * [Generator](#Generator) * [new Generator(templateName, targetDir, options)](#new_Generator_new) * _instance_ * [.generate(asyncapiDocument)](#Generator+generate) ⇒ Promise * [.generateFromString(asyncapiString, [asyncApiFileLocation])](#Generator+generateFromString) ⇒ Promise * [.generateFromFile(asyncapiFile)](#Generator+generateFromFile) ⇒ Promise * [.getAllParameters(asyncapiDocument)](#Generator+getAllParameters) * [.installTemplate([force])](#Generator+installTemplate) * _static_ * [.getTemplateFile(templateName, filePath, options)](#Generator.getTemplateFile) ⇒ Promise ### new Generator(templateName, targetDir, options) Instantiates a new Generator object. | Param | Type | Default | Description | | --- | --- | --- | --- | | templateName | String | | Name of the template to generate. | | targetDir | String | | Path to the directory where the files will be generated. | | options | Object | | | | [options.templatesDir] | String | | Path to the directory where to find the given template. Defaults to internal `templates` directory. | | [options.templateParams] | String | | Optional parameters to pass to the template. Each template define their own params. | | [options.entrypoint] | String | | Name of the file to use as the entry point for the rendering process. Use in case you want to use only a specific template file. Note: this potentially avoids rendering every file in the template. | | [options.noOverwriteGlobs] | Array.<String> | | List of globs to skip when regenerating the template. | | [options.disabledHooks] | Array.<String> | | List of hooks to disable. | | [options.output] | String | 'fs' | Type of output. Can be either 'fs' (default) or 'string'. Only available when entrypoint is set. | | [options.forceWrite] | Boolean | false | Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir. Default is set to false. | | [options.forceInstall] | Boolean | false | Force the installation of the template dependencies. By default, dependencies are installed and this flag is taken into account only if `node_modules` is not in place. | **Example** ```js const path = require('path'); const generator = new Generator('html', path.resolve(__dirname, 'example')); ``` **Example** *(Passing custom params to the template)* ```js const path = require('path'); const generator = new Generator('html', path.resolve(__dirname, 'example'), { templateParams: { sidebarOrganization: 'byTags' } }); ``` **Example** *(Specifying a custom directory for templates)* ```js const path = require('path'); const generator = new Generator('myTemplate', path.resolve(__dirname, 'example'), { templatesDir: path.resolve(__dirname, 'my-templates') }); ``` ### generator.generate(asyncapiDocument) ⇒ Promise Generates files from a given template and an AsyncAPIDocument object. **Kind**: instance method of [Generator](#Generator) | Param | Type | Description | | --- | --- | --- | | asyncapiDocument | AsyncAPIDocument | AsyncAPIDocument object to use as source. | **Example** ```js generator .generate(myAsyncAPIdocument) .then(() => { console.log('Done!'); }) .catch(console.error); ``` **Example** *(Using async/await)* ```js try { await generator.generate(myAsyncAPIdocument); console.log('Done!'); } catch (e) { console.error(e); } ``` ### generator.generateFromString(asyncapiString, [asyncApiFileLocation]) ⇒ Promise Generates files from a given template and AsyncAPI string. **Kind**: instance method of [Generator](#Generator) | Param | Type | Description | | --- | --- | --- | | asyncapiString | String | AsyncAPI string to use as source. | | [asyncApiFileLocation] | String | AsyncAPI file location, used by the asyncapi-parser for references. | **Example** ```js const asyncapiString = ` asyncapi: '2.0.0' info: title: Example version: 1.0.0 ... `; generator .generateFromString(asyncapiString) .then(() => { console.log('Done!'); }) .catch(console.error); ``` **Example** *(Using async/await)* ```js const asyncapiString = ` asyncapi: '2.0.0' info: title: Example version: 1.0.0 ... `; try { await generator.generateFromString(asyncapiString); console.log('Done!'); } catch (e) { console.error(e); } ``` ### generator.generateFromFile(asyncapiFile) ⇒ Promise Generates files from a given template and AsyncAPI file. **Kind**: instance method of [Generator](#Generator) | Param | Type | Description | | --- | --- | --- | | asyncapiFile | String | AsyncAPI file to use as source. | **Example** ```js generator .generateFromFile('asyncapi.yaml') .then(() => { console.log('Done!'); }) .catch(console.error); ``` **Example** *(Using async/await)* ```js try { await generator.generateFromFile('asyncapi.yaml'); console.log('Done!'); } catch (e) { console.error(e); } ``` ### generator.getAllParameters(asyncapiDocument) **Kind**: instance method of [Generator](#Generator) | Param | Type | Description | | --- | --- | --- | | asyncapiDocument | AsyncAPIDocument | AsyncAPI document to use as the source. | ### generator.installTemplate([force]) Installs template dependencies. **Kind**: instance method of [Generator](#Generator) | Param | Type | Default | Description | | --- | --- | --- | --- | | [force] | Boolean | false | Whether to force installation or not. | ### Generator.getTemplateFile(templateName, filePath, options) ⇒ Promise Returns the content of a given template file. **Kind**: static method of [Generator](#Generator) | Param | Type | Description | | --- | --- | --- | | templateName | String | Name of the template to generate. | | filePath | String | Path to the file to render. Relative to the template directory. | | options | Object | | | [options.templatesDir] | String | Path to the directory where to find the given template. Defaults to internal `templates` directory. | **Example** ```js const Generator = require('asyncapi-generator'); const content = await Generator.getTemplateFile('html', '.partials/content.html'); ``` **Example** *(Obtaining the content of a file from a custom template)* ```js const path = require('path'); const Generator = require('asyncapi-generator'); const content = await Generator.getTemplateFile('myTemplate', 'a/file.js', { templatesDir: path.resolve(__dirname, 'my-templates') }); ```