[sr-dev] git:master:1b831f8d: modules: readme files regenerated - app_jsdt ... [skip ci]

Kamailio Dev kamailio.dev at kamailio.org
Thu Mar 8 13:16:51 CET 2018


Module: kamailio
Branch: master
Commit: 1b831f8dab3fb9f7c0c4562fee6d192face16e56
URL: https://github.com/kamailio/kamailio/commit/1b831f8dab3fb9f7c0c4562fee6d192face16e56

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2018-03-08T13:16:28+01:00

modules: readme files regenerated - app_jsdt ... [skip ci]

---

Modified: src/modules/app_jsdt/README

---

Diff:  https://github.com/kamailio/kamailio/commit/1b831f8dab3fb9f7c0c4562fee6d192face16e56.diff
Patch: https://github.com/kamailio/kamailio/commit/1b831f8dab3fb9f7c0c4562fee6d192face16e56.patch

---

diff --git a/src/modules/app_jsdt/README b/src/modules/app_jsdt/README
index 8679cb1bd6..4186cced58 100644
--- a/src/modules/app_jsdt/README
+++ b/src/modules/app_jsdt/README
@@ -79,14 +79,15 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module allows executing JavaScript scripts from config file. It
-   exports all KEMI functions to JavaScript in order to access the current
-   processed SIP message. These functions are within JavaScript object
-   'KSR'.
+   This module allows executing JavaScript scripts from the Kamailio
+   configuration file. It exports all KEMI functions to JavaScript in
+   order to access the currently processed SIP message. These functions
+   are named within the JavaScript object 'KSR'.
 
-   It includes the Duktape JavaScript engine (http://www.duktape.org),
-   which is a fast and easy to embed JavaScript interpreter. Exported API
-   from SIP router to JavaScript is documented in the dokuwiki.
+   The module is based on the Duktape JavaScript engine
+   (http://www.duktape.org), which is a fast and easy to embed JavaScript
+   interpreter. The exported API from Kamailio to JavaScript is documented
+   in the wiki.
 
    The module has two JavaScript contexts:
      * first is used for functions jsdt_dofile() and jsdt_dostring().
@@ -94,7 +95,7 @@ Chapter 1. Admin Guide
        Therefore jsdt_run() cannot execute functions from scripts loaded
        via jsdt_dofile() in config. This is kind of caching mode, avoiding
        reading file every time, but you must be sure you do not have
-       something that is executed by default and requires access to SIP
+       someting that is executed by default and requires access to SIP
        message. This environment is also used by KEMI framework for the
        config SIP routing functions.
 
@@ -113,7 +114,7 @@ Chapter 1. Admin Guide
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
      * libm - the math library (part of standard system libraries - it is
-       needed to compile embedded Duktape JS interpreter).
+       needed to complile embedded Duktape JS interpreter).
 
 3. Parameters
 
@@ -142,8 +143,8 @@ modparam("app_jsdt", "load", "/usr/local/etc/kamailio/js/myscript.js")
 
 4.1.  jsdt_dofile(path)
 
-   Execute the JS script stored in 'path'. The parameter can be a string
-   with pseudo-variables evaluated at runtime.
+   Execute the JavaScript script stored in 'path'. The parameter can be a
+   string with pseudo-variables evaluated at runtime.
 
    Example 1.2. jsdt_dofile usage
 ...
@@ -152,8 +153,8 @@ jsdt_dofile("/usr/local/etc/kamailio/js/myscript.js");
 
 4.2.  jsdt_dostring(script)
 
-   Execute the Lua script stored in parameter. The parameter can be a
-   string with pseudo-variables.
+   Execute the JavaScript script stored in parameter. The parameter can be
+   a string with pseudo-variables.
 
    Example 1.3. jsdt_dostring usage
 ...
@@ -229,7 +230,7 @@ kamcmd app_jsdt.api_list
 
 6. Example of usage
 
-   Create your JS script and stored on file system, say:
+   Create your JS script and store it on the file system, say:
    '/usr/local/etc/kamailio/js/myscript.js'.
 ...
 function sr_append_fu_to_reply()




More information about the sr-dev mailing list