chore(docs): add docs for _brs_.testData (#88)

hulu · May 18, 2021 · a447916 · a447916
1 parent 9307810
commit a447916
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/api/reference/globals.md b/docs/api/reference/globals.md
@@ -57,6 +57,7 @@ These extensions are all available on a global associative array called `_brs_`:
 {
     getStackTrace: function,
     global: associative array,
+    testData: associative array,
     mockComponent: function,
     mockComponentPartial: function,
     mockFunction: function,

diff --git a/docs/api/reference/test-utilities.md b/docs/api/reference/test-utilities.md
@@ -57,6 +57,26 @@ print _brs_.global
 
 ------------
 
+## \_brs_.testData
+
+A reference to the temporary associative array, so that you can access it from everywhere inside your brs code. Mostly used for saving/accessing some test-specific data. Clears before running each test file.
+
+### Usage
+```brightscript
+_brs_.testData._isFooAvailable = false
+_brs_.mockFunction("isFooAvailable", sub()
+    return _brs_.testData._isFooAvailable
+end sub)
+
+isFooAvailable() ' => false
+
+_brs_.testData._isFooAvailable = true ' something happened and now it is available
+isFooAvailable() ' => true
+```
+<br/>
+
+------------
+
 # \_brs_.process
 
 Allows you to access the command line arguments and locale.