@aj-shadow/actorjs-documentation-text 0.0.0-aj-beta.221

package/Documentation/stack-api/Document-global-ip-log.txt

@@ -0,0 +1,101 @@
+# **IpLog API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=FULLY, ]]
+
+[[NOTE={"guid":"7166df59-0b52-4fdd-aceb-e9bc07ad1e30"}]]
+[[ANCHOR={"id":"ac7a94aa-9d10-4196-93bb-2edf5f1f8b63","visible":true}]]
+## **Description**
+Class to create logs. The IpLog object will be a member of either the Encoder or Decoder.
+
+[[NOTE={"guid":"6dd192ef-b476-4abf-8591-9ca04a882fa0"}]]
+[[ANCHOR={"id":"eed66ffe-38a2-4ea3-868a-8faefc518c7d","visible":true}]]
+## **API Methods**
+* **[addLog](#stack-api-ip-log-addLog)**
+* **[setCaption](#stack-api-ip-log-set-caption)**
+
+***
+[[NOTE={"guid":"861c29cb-5a9d-4d53-abf4-29d334db4d49"}]]
+[[ANCHOR={"id":"stack-api-ip-log-addLog","visible":true}]]
+### **addLog**
+```
+ipLog.addLog(innerLog);
+```
+
+[[NOTE={"guid":"f648e1ab-8bbf-45d7-8bff-ebdc9a5744d1"}]]
+[[ANCHOR={"id":"4455d571-5cf9-4289-8c32-001874821966","visible":true}]]
+#### **Method Description**
+Adds a log or a part of a log.
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                         |
+|Name    |Type                        |Description                                  |
+|innerLog|[[REF=,API_Stack_Log_Inner]]|The [[REF=,API_Stack_Log_Inner]] to be added.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                                                    |
+|Type                        |Description                                   |
+|[[REF=,API_Stack_Log_Inner]]|The added [[REF=,API_Stack_Log_Inner]] object.|
+```
+[[NOTE={"guid":"10c93146-9d6c-4c51-8583-25fea31a1a3f"}]]
+[[ANCHOR={"id":"a48029f4-39b2-4e5a-977a-b481fa09ca77","visible":true}]]
+#### **Example adding a LogInner**
+The method in the example is a member of a Decoder inheriting from the StackApi.Decoder.
+
+```javascript
+
+*decodeHeaders() {
+  while(this._parseHeaderLine(yield* this.receiveLine()));
+    if(this.isLogIp) {
+      this.addLog(HttpInnerLog.createHeaders(this.msg));
+    }
+  }
+}
+
+```
+
+***
+[[NOTE={"guid":"2e15604d-bf18-4a4d-b55c-5af88f263b31"}]]
+[[ANCHOR={"id":"stack-api-ip-log-set-caption","visible":true}]]
+### **setCaption**
+```
+ipLog.setCaption(caption);
+```
+
+[[NOTE={"guid":"76ddc91e-4eea-4c38-960b-1b89331be0b9"}]]
+[[ANCHOR={"id":"15336b7a-74aa-48d0-bf5e-78bcf7a913b1","visible":true}]]
+#### **Method Description**
+Sets the caption of a log.
+
+```table
+Config(classHeading: )
+
+|Parameters                                          |
+|Name   |Type                |Description            |
+|caption|[[REF=, MDN_string]]|The caption of the log.|
+```
+
+[[NOTE={"guid":"a8f2047d-4e4d-44f6-859c-d1711723ea3f"}]]
+[[ANCHOR={"id":"a695c2f90-e17b-4e2f-9ed7-ac3083a8d3b9","visible":true}]]
+#### **Example adding a LogInner**
+The method in the example is a member of a Decoder inheriting from the StackApi.Decoder.
+
+```javascript
+
+*_receiveAll() {
+  yield* this._decodeHeader();
+  yield* this._decodeAvps();
+  if(this.isLogIp) {
+    this.addLog(DiameterInnerLog.createHeader(this.msg));
+    this.addLog(DiameterInnerLog.createAvps(this.msg.avps));
+    this.setCaption(DiameterInnerLog.createCaption(this.msg, this.externalDecoding ? this.externalDecoding.commandCode : undefined));
+    this.logMessage();
+  }
+  return this.msg;
+}
+
+```

package/Documentation/stack-api/Document-global-log-inner.txt

@@ -0,0 +1,152 @@
+# **LogInner API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=MOSTLY, ]]
+
+[[NOTE={"guid":"9d6013a8-d50d-44b2-8baf-87239a120283"}]]
+[[ANCHOR={"id":"6812d1d7-1e95-4f67-9027-ba47b197a1ce","visible":true}]]
+## **Description**
+Class to add inner logs to the ipLog. The inner log can contain other inner logs or log parts that are written in the log. With help of the InnerLog object can you build a tree of log data.
+
+[[NOTE={"guid":"33aa6a2d-a262-4247-8cb3-f7bfe15402c8"}]]
+[[ANCHOR={"id":"95eef9a0-9ca8-45c2-a4d1-9985b97f374e","visible":true}]]
+## **API Methods**
+* **[constructor](#stack-api-log-inner-constructor)**
+* **[add](#stack-api-log-inner-add)**
+
+***
+[[NOTE={"guid":"9e844b49-3034-435a-bff5-2308978fc034"}]]
+[[ANCHOR={"id":"stack-api-log-inner-constructor","visible":true}]]
+### **constructor**
+```
+new LogInner(logParts, inner, open);
+```
+
+[[NOTE={"guid":"e1d766a7-ff19-4ffa-ae5e-d07bf41a0f65"}]]
+[[ANCHOR={"id":"e7527b8b-7da3-481b-a237-144813b226f7","visible":true}]]
+#### **Method Description**
+
+Creates an inner log.
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                                                                        |
+|Name    |Type                                                                                                                                                                                                                                |Description                                         |
+|logParts|[[REF=, MDN_string]] | [[REF=,API_Stack_Log_Part_Text]] | [[REF=,API_Stack_Log_Part_Ref]] | [[[REF=,API_Stack_Log_Part_Text]] | [[REF=,API_Stack_Log_Part_Ref]]]|Log parts, text or uri.                             |
+|inner   |[[REF=,API_Stack_Log_Inner]] | [[REF=,API_Stack_Log_Inner_Array]]                                                                                                                                                    |Inner log object(s).                                |
+|open    |[[REF=, MDN_boolean]]                                                                                                                                                                                                               |Decides if the innerLog objects are open by default.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                                                      |
+|Type                        |Description                                     |
+|[[REF=,API_Stack_Log_Inner]]|The created [[REF=,API_Stack_Log_Inner]] object.|
+```
+[[NOTE={"guid":"026943a3-6e35-4ad6-a0dc-d70835527ec5"}]]
+[[ANCHOR={"id":"f6fc97f2-9a56-4d63-8ca8-d1faa1dc5877","visible":true}]]
+#### **Example using LogInner**
+
+```javascript
+
+const StackApi = require('stack-api');
+
+
+static generateLog(msg, ipLogs) {
+  const innerLog = new StackApi.LogInner(msg.msgId);
+  ipLogs.push(innerLog);
+   
+  if('INVITE' === msg.msgId) {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see InnerLog help: '));
+    innerParts.push(new StackApi.LogPartRef('InnerLog help', '/documentation/stack-api/log-inner'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  else {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see LogPartRef help: '));
+    innerParts.push(new StackApi.LogPartRef('LogPartRef help', '/documentation/stack-api/log-part-ref'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  return msg.msgId;
+}
+```
+
+[[NOTE={"guid":"0a72fb99-d780-4900-916d-df4cbd2b9928"}]]
+[[ANCHOR={"id":"3e59d392-a75d-4a03-a964-d8369dffb277","visible":true}]]
+#### **Test Cases constructor**
++ [DocStackApiText](/../test-cases/Actor/Doc/DocStackApiText/definition)
+
+
+***
+[[NOTE={"guid":"37fda9fc-ee65-4f4d-8cc8-8f63d2357174"}]]
+[[ANCHOR={"id":"stack-api-log-inner-add","visible":true}]]
+### **add**
+```
+innerLog.add(new LogInner(logParts, inner, open));
+```
+
+[[NOTE={"guid":"0ccec19d-f483-447d-97f3-8a05a6919a05"}]]
+[[ANCHOR={"id":"51e74c5d-e65e-4a3c-ae79-f600f9971882","visible":true}]]
+#### **Method Description**
+
+Adds an inner log to another inner log.
+
+```table
+Config(classHeading: )
+
+|Parameters                                                                      |
+|Name |Type                        |Description                                  |
+|inner|[[REF=,API_Stack_Log_Inner]]|The [[REF=,API_Stack_Log_Inner]] to be added.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                                                    |
+|Type                        |Description                                   |
+|[[REF=,API_Stack_Log_Inner]]|The added [[REF=,API_Stack_Log_Inner]] object.|
+```
+[[NOTE={"guid":"cb632fe1-3527-4703-9867-5732dab67feb"}]]
+[[ANCHOR={"id":"f2ce7ff4-dd2e-45c3-89db-b3385a1a727d","visible":true}]]
+#### **Example adding a LogInner**
+
+```javascript
+
+const StackApi = require('stack-api');
+
+
+static generateLog(msg, ipLogs) {
+  const innerLog = new StackApi.LogInner(msg.msgId);
+  ipLogs.push(innerLog);
+   
+  if('INVITE' === msg.msgId) {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see InnerLog help: '));
+    innerParts.push(new StackApi.LogPartRef('InnerLog help', '/documentation/stack-api/log-inner'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  else {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see LogPartRef help: '));
+    innerParts.push(new StackApi.LogPartRef('LogPartRef help', '/documentation/stack-api/log-part-ref'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  return msg.msgId;
+}
+```
+
+[[NOTE={"guid":"2ce3dd14-7178-45ef-b0a7-411a1964b9ec"}]]
+[[ANCHOR={"id":"7a0ab84c-8b9a-4cbc-882f-2e7b3d642248","visible":true}]]
+#### **Test Cases add**
++ [DocStackApiText](/../test-cases/Actor/Doc/DocStackApiText/definition)
+
+***

package/Documentation/stack-api/Document-global-log-part-error.txt

@@ -0,0 +1,12 @@
+# **LogPartError API**
+[[API-STATUS=STABLE,]]
+[[DOC-STATUS=NOT-YET, ]]
+
+[[NOTE={"guid":"dc119889-9217-4225-9a8f-8da3462b11f6"}]]
+[[ANCHOR={"id":"969b8a40-689a-4f03-9ae5-c70ba8de2bb1","visible":true}]]
+## **Description**
+
+[[NOTE={"guid":"36639541-1d94-4876-a43f-c42956532911"}]]
+[[ANCHOR={"id":"8b5c98aa-5c56-426c-ad42-27bd0ad2a606","visible":true}]]
+## **API Methods**
+* **[constructor](#stack-api-constructor)**

package/Documentation/stack-api/Document-global-log-part-ref.txt

@@ -0,0 +1,80 @@
+# **LogPartRef API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=FULLY, ]]
+
+[[NOTE={"guid":"2d4c23b9-b3cd-46c7-9138-95eb7da954f1"}]]
+[[ANCHOR={"id":"85769236-57dd-4e0d-b23c-d05214af923c","visible":true}]]
+## **Description**
+
+[[NOTE={"guid":"ebb16afd-49a8-4911-9ddb-52447bbca49a"}]]
+[[ANCHOR={"id":"d82a1cf5-0b25-453c-a648-71c4eca91ec0","visible":true}]]
+## **API Methods**
+* **[constructor](#stack-api-log-part-ref-constructor)**
+
+***
+[[NOTE={"guid":"762dd0e8-7cc5-449f-b4d4-45d9fcc0c1f4"}]]
+[[ANCHOR={"id":"stack-api-log-part-ref-constructor","visible":true}]]
+### **constructor**
+```
+new LogPartRef(text, ref);
+```
+
+[[NOTE={"guid":"18be59ce-596e-4bf0-858d-ec264cd6e937"}]]
+[[ANCHOR={"id":"6971f371-cba1-49dd-9077-e6f7595360a9","visible":true}]]
+#### **Method Description**
+
+Creates an a anchor link in an inner log.
+```table
+Config(classHeading: )
+
+|Parameters                                                     |
+|Name|Type                |Description                          |
+|text|[[REF=, MDN_string]]|The text.                            |
+|ref |[[REF=, MDN_string]]|The url witch the referense leads to.|
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                                                            |
+|Type                           |Description                                        |
+|[[REF=,API_Stack_Log_Part_Ref]]|The created [[REF=,API_Stack_Log_Part_Ref]] object.|
+```
+[[NOTE={"guid":"affe69f1-8ad6-4644-a5a7-f1911cf049b2"}]]
+[[ANCHOR={"id":"83df9526-5fcb-462b-b46a-439c04e743ea","visible":true}]]
+#### **Example using LogPartRef**
+
+```javascript
+
+const StackApi = require('stack-api');
+
+static generateLog(msg, ipLogs) {
+  const innerLog = new StackApi.LogInner(msg.msgId);
+  ipLogs.push(innerLog);
+   
+  if('INVITE' === msg.msgId) {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see InnerLog help: '));
+    innerParts.push(new StackApi.LogPartRef('InnerLog help', '/documentation/stack-api/log-inner'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  else {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see LogPartRef help: '));
+    innerParts.push(new StackApi.LogPartRef('LogPartRef help', '/documentation/stack-api/log-part-ref'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  return msg.msgId;
+}
+```
+
+[[NOTE={"guid":"0d4551a1-f0dd-4750-987f-a25f85efb474"}]]
+[[ANCHOR={"id":"9603d93b-4a61-46fe-8d52-2fb773d6629b","visible":true}]]
+#### **Test Cases constructor**
++ [DocStackApiText](/../test-cases/Actor/Doc/DocStackApiText/definition)
+
+***

package/Documentation/stack-api/Document-global-log-part-text.txt

@@ -0,0 +1,81 @@
+# **LogPartText API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=FULLY, ]]
+
+[[NOTE={"guid":"3d34babf-7d42-46bc-8dcb-01dc65a6cf8e"}]]
+[[ANCHOR={"id":"3b7693b8-e3b0-4b9f-abfb-f6f9a9ce0843","visible":true}]]
+## **Description**
+The LogPartText object writes a text in an inner log, [[REF=, API_Stack_Log_Inner]].
+
+[[NOTE={"guid":"619cacb8-e2fe-44a0-9afc-8af10288a88d"}]]
+[[ANCHOR={"id":"dfafa600-238e-48c1-af41-48fac3c601a1","visible":true}]]
+## **API Methods**
+* **[constructor](#stack-api-log-part-text-constructor)**
+
+***
+[[NOTE={"guid":"72d4a0f3-a380-47b9-8963-44304bc18cb0"}]]
+[[ANCHOR={"id":"stack-api-log-part-text-constructor","visible":true}]]
+### **constructor**
+```
+new LogPartText(text);
+```
+
+[[NOTE={"guid":"f753ab57-d161-43dd-ae5e-f768eb7e46da"}]]
+[[ANCHOR={"id":"2b20ac05-75fb-492e-8307-12ce4ca844a9","visible":true}]]
+#### **Method Description**
+
+Creates an a text in an inner log.
+```table
+Config(classHeading: )
+
+|Parameters                           |
+|Name|Type                |Description|
+|text|[[REF=, MDN_string]]|The text.  |
+```
+
+```table
+Config(classHeading: )
+
+|Returns                                                                              |
+|Type                            |Description                                         |
+|[[REF=,API_Stack_Log_Part_Text]]|The created [[REF=,API_Stack_Log_Part_Text]] object.|
+```
+[[NOTE={"guid":"1299fc8d-b321-4835-9455-2752267ac696"}]]
+[[ANCHOR={"id":"ee6d08f4-d3a2-4305-8d18-7c08a2703acf","visible":true}]]
+#### **Example using LogPartText**
+
+```javascript
+
+const StackApi = require('stack-api');
+
+
+static generateLog(msg, ipLogs) {
+  const innerLog = new StackApi.LogInner(msg.msgId);
+  ipLogs.push(innerLog);
+   
+  if('INVITE' === msg.msgId) {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see InnerLog help: '));
+    innerParts.push(new StackApi.LogPartRef('InnerLog help', '/documentation/stack-api/log-inner'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  else {
+    const innerParts = [];
+    innerParts.push(new StackApi.LogPartText('msg: '));
+    innerParts.push(new StackApi.LogPartText(msg.msg));
+    innerParts.push(new StackApi.LogPartText(' - see LogPartRef help: '));
+    innerParts.push(new StackApi.LogPartRef('LogPartRef help', '/documentation/stack-api/log-part-ref'));
+    innerLog.add(new StackApi.LogInner(innerParts));
+  }
+  return msg.msgId;
+}
+```
+
+[[NOTE={"guid":"f886020b-0eaf-4aa8-a8de-6a6a2be55b7d"}]]
+[[ANCHOR={"id":"64c76f24-4c37-452a-b610-1f2ed46b61d5","visible":true}]]
+#### **Test Cases constructor**
++ [DocStackApiText](/../test-cases/Actor/Doc/DocStackApiText/definition)
+
+***