Js-templates.class-export NPM

js-templates.class-export

Generate a sample class export code.

:cloud: Installation

# Using npm
npm install --save js-templates.class-export

# Using yarn
yarn add js-templates.class-export

:clipboard: Example

const classExport = require("js-templates.class-export");

console.log(classExport("foo"));
// "use strict";
//
// module.exports = class Foo {
//     /**
//      * Foo
//      * Sample description
//      *
//      * @name Foo
//      * @function
//      * @param {Object} options An object containing the following fields:
//      *
//      *  - `fieldOne` (Number): Any number (default: `42`).
//      *
//      * @return Foo The `Foo` instance.
//      */
//     constructor (options) {
//         /* do something */
//     }
// };

console.log(classExport("bar", "Class description"));
// "use strict";
//
// module.exports = class Bar {
//     /**
//      * Bar
//      * Class description
//      *
//      * @name Bar
//      * @function
//      * @param {Object} options An object containing the following fields:
//      *
//      *  - `fieldOne` (Number): Any number (default: `42`).
//      *
//      * @return Bar The `Bar` instance.
//      */
//     constructor (options) {
//         /* do something */
//     }
// };

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

`classExport(name, desc)`

Generates a class export template.

Params

String name: The function name.
String desc: The function description (optional).

Return

String The rendered template.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6