View GitHub Repository SARAH-lib-utils

Schedule Inspection
Subscribe
Passed
Pull Request — master (#4)
by Yo
02:45 queued 01:18
created

index.js   A

↳ Parent: Project

Complexity

Total Complexity 0
Complexity/F 0

Size

Lines of Code 7
Function Count 0

Duplication

Duplicated Lines 0
Ratio 0 %

Test Coverage

Coverage 100%

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 0
c 1
b 0
f 0
nc 1
dl 0
loc 7
ccs 6
cts 6
cp 1
crap 0
rs 10
wmc 0
mnd 0
bc 0
fnc 0
bpm 0
cpm 0
noi 0
1 
/* globals module */
2 
/**
3 
 * @summary SARAH utils library
4 
 * @description Library with helpful class for S.A.R.A.H.
5 
 *
6 
 * @example <caption>S.A.R.A.H. integration</caption>
7 
 * // your_plugin_name.js
8 
 * const sarahLibUtils = require('sarah.lib.utils');
9 
 * const SarahActionContext = sarahLibUtils.SarahActionContext;
10 
 * const SarahActionHelper = sarahLibUtils.SarahActionHelper;
11 
 * const version = sarahLibUtils.version;
12 
 * exports.action = function (data, callback, config, SARAH) {
13 
 *     var context = new SarahActionContext(data, callback);
14 
 *     var helper = new SarahActionHelper(context);
15 
 *     if (version.isV3()) {
16 
 *          context.setSARAH(SARAH); // For v3 compatibility
17 
 *     }
18 
 *     var monModule = new MyModule();
19 
 *     monModule.process(helper);
20 
 * };
21 
 */
22 

            


            
                                                        
            
                                    
            
            

                
                    23
                

                                    
                             1                         
                
                
                
var sarahLibUtils = {};

            


            
                                                        
            
                                    
            
            

                
                    24
                

                                    
                             1                         
                
                
                
sarahLibUtils.SarahActionContext = require('./actionContext');

            


            
                                                        
            
                                    
            
            

                
                    25
                

                                    
                             1                         
                
                
                
sarahLibUtils.SarahActionHelper = require('./actionHelper');

            


            
                                                        
            
                                    
            
            

                
                    26
                

                                    
                             1                         
                
                
                
sarahLibUtils.SarahLogger = require('./logger');

            


            
                                                        
            
                                    
            
            

                
                    27
                

                                    
                             1                         
                
                
                
sarahLibUtils.version = require('./version');

            


            
                                                        
            
                                    
            
            

                
                    28
                

                                    
                                                    
                
                
                

            


            
                                                        
            
                                    
            
            

                
                    29
                

                                    
                                                    
                
                
                
module.exports = sarahLibUtils;

            


            
                                                        
            
                                    
            
            

                
                    30