class-o-mat-help-plugin

    0.0.3 • Public • Published

    ClassOMat Help Plugin

    Allows help commands to be added to Classes generated by ClassOMat

    Version 0.0.3 (Alpha):

    Recommend using "~0.x.x" instead of "^0.x.x" in the package.json reference to this package. Compatible with ClassOMat v~0.5.4

    Basic Usage.

       import ClassOMat from 'class-o-mat';
       import helpPlugin from 'class-o-mat-help-plugin';
    
       const classOMat = new ClassOMat('testClassOMat');
       helpPlugin.connect(classOMat);
    
       classOMat.field('name').help('Your name here').validate().string().$();
       classOMat.field('age').help('Your age here').validate().uint().$();
    
       const minion = new (classOMat.$())();
       minion.___help().name(); // 'Your name here';
       minion.___help().age(); // 'Your age here';
       minion.___help().___data(); // returns help as object
       minion.___help().___json(); // returns help as JSON string.
    
       minion.name('George'); // sets name to George
       minion.name(); // George.
    
    

    Coming in later versions:

    • File output for help information.
    • Ability to attach template to help.

    Release Notes:


    Version 0.0.3

    upped class-o-mat requirement to 0.5.6 and data-object-plugin to 0.0.4

    Version 0.0.2

    Added .npmignore to ensure lib is published properly

    Version 0.0.1

    Initial publish of basic version of help plugin.

    Keywords

    none

    Install

    npm i class-o-mat-help-plugin

    DownloadsWeekly Downloads

    1

    Version

    0.0.3

    License

    GPL-2.0

    Last publish

    Collaborators

    • bobbwhy