- update readme

suiteplus · Sep 30, 2015 · 57f1357 · 57f1357
1 parent 3e61879
commit 57f1357
Showing 1 changed file with 85 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -14,35 +14,100 @@ Netsuite API Mockup
 #### nsmockup.init(opt, cb)
  - opt {records: [String], metadatas: [String]}
  - cb  {Function}
+```javascript
+    var opt = {
+        records: {
+            "customrecord_my-record": __dirname + '/data/customrecord_my-record.json'
+        },
+        metadatas: [
+            __dirname + '/meta/metaData-customrecord_my-record.json'
+        ]
+    };
+    nsmockup.init(opt, function(err) {
+        if (err) console.log('ERROR', err);
+        else console.log('start Netsuite API simulation')
+    });
+```
 
 #### nsmockup.createSuitelet(cfg)
- - cfg {name: String, func: String, files: [String]}
+ - cfg {name: String, func: String, files: [String], params: Object}
+```javascript
+    nsmockup.createSuitelet({
+        name: 'my_suitelet',
+        func: 'MySuitelet.main',
+        files: [
+            __dirname + '/lib/my-suitelet.js'
+        ]
+    });
+```
 
 #### nsmockup.createReslet(cfg)
- - cfg {name: String, func: String, files: [String]}
+ - cfg {name: String, func: String, files: [String], params: Object}
+```javascript
+    nsmockup.createReslet({
+        name: 'my_restlet',
+        func: 'MyRestlet.main',
+        files: [
+            __dirname + '/lib/my-restlet.js'
+        ]
+    });
+```
+
+#### nsmockup.createSchedule(cfg)
+ - cfg {name: String, func: String, files: [String], params: Object}
+```javascript
+    nsmockup.createSchedule({
+        name: 'my_schedule',
+        func: 'MySchedule.main',
+        files: [
+            __dirname + '/lib/my-schedule.js'
+        ]
+    });
+```
 
 #### nsmockup.destroy(cb)
  - cb  {Function}
+```javascript
+    nsmockup.destroy(function(err) {
+        if (err) console.log('ERROR', err);
+        else console.log('finish Netsuite API simulation')
+    });
+```
 
-## Example
+## Example with Mocha
 ```javascript
-    var nsmockup = require('nsmockup');
-
-    // map record types
-    let metadatas = [
-            __dirname + '/record/meta/recordType-metaData-codeg.json',
-            __dirname + '/record/meta/recordType-metaData-codeg_ids.json'
-        ],
-        records = {
-            'customrecord_codeg': __dirname + '/record/data/recordType-codeg.json',
-            'customrecord_codeg_ids': __dirname + '/record/data/recordType-codeg_ids.json'
-        };
-
-    // start database simulation
-    nsmockup.init({records, metadatas}, function(err) {
-        if (err) throw err;
-
-        console.log('search record', nlapiSearchRecord('customrecord_codeg'));
+'use strict';
+var nsmockup = require('nsmockup');
+describe('<Unit Test - Netsuite API Simulation>', function () {
+
+    before(function (done) {
+        // map record types
+        let metadatas = [
+                __dirname + '/record/meta/recordType-metaData-codeg.json',
+                __dirname + '/record/meta/recordType-metaData-codeg_ids.json'
+            ],
+            records = {
+                'customrecord_codeg': __dirname + '/record/data/recordType-codeg.json',
+                'customrecord_codeg_ids': __dirname + '/record/data/recordType-codeg_ids.json'
+            };
+
+        // start database simulation
+        nsmockup.init({records, metadatas}, done);
+    });
+
+    it('simple load lib and execute function', function (done) {
+        nsmockup.createReslet({
+            name: 'my_restlet',
+            func: 'MyRestlet.main',
+            files: [
+                __dirname + '/lib/my-restlet.js'
+            ]
+         });
+         MyRestlet.main();
+    });
+
+    after(function (done) {
+        nsmockup.destroy(done);
     });
 ```