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

package/Documentation/actor-api/Document-global-timer.txt

@@ -0,0 +1,70 @@
+# **Timer API**
+[[API-STATUS=STABLE, ]]
+[[DOC-STATUS=PARTLY, ]]
+
+## **Description**
+
+Timer functions for [[REF=, ABS_Actor]]s.
+
+Timer API implementation starts in [timer-mixin.js](/../code-editor/project/server/engine/actor/actor-mixins/timer-mixin.js).
+
+[[ANCHOR={"id":"timer-api-methods","visible":true}]]
+## **API Methods**
++ **[*delay](#timer-api-delay)**
++ **[*interval](#timer-api-interval)**
+
+***
+[[ANCHOR={"id":"timer-api-delay","visible":true}]]
+### ***delay**
+```
+this.delay(milliSeconds)
+```
+Delays the state execution. `warning:` using delays in [[REF=, ABS_Test_Case]]s are usually a bad habit and if it is done in a lot of [[REF=, ABS_Test_Case]]s it can make the CI slow.
+
+#### **Method Description**
+```table
+Config(classHeading: )
+
+|Parameters                                                                                                                                                                                                                                          |
+|Name        |Type               |Description                                                                                                                                                                                                        |
+|milliSeconds|[[REF=,MDN_number]]|***milliseconds > 0***: delay the execution milliseconds ms.<br />***milliseconds === 0***: yield, leaves the execution but returns as quick as possible.<br />***milliseconds < 0***: no delay, it just continues.|
+```
+
+```table
+Config(classHeading: )
+
+|Async                |
+|type  |Description   |
+|yield*|auto generated|
+```
+
+#### **Example using delay**
+
+```javascript
+
+
+
+
+
+*run() {
+  this.delay(2);  // will delay the execution 2 milliseconds.
+
+  this.httpConnection.send(new HttpMsgGetRequest(this.requistUri));
+    
+  const response = this.httpConnection.receive();
+  VERIFY_VALUE(HttpApi.StatusCode.OK, response.statusCode, ' HTTP response line status code:');
+  VERIFY_CONTENT_OPTIONAL('content-name', response.getHeaderNumber(HttpApi.Header.CONTENT_LENGTH), response.getBody());
+}
+
+```
+
+#### **Test Cases using delay**
++ [DocActorApiTimerDelay](/../test-cases/Actor/Doc/DocActorApiTimerDelay)
+
+***
+[[ANCHOR={"id":"timer-api-interval","visible":true}]]
+### ***interval**
+
+#### `Not Implemented`
+
+***