TheHomecraft/MineOS
1
0
Fork 0
mirror of https://github.com/IgorTimofeev/MineOS.git synced 2026-01-06 11:12:40 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Text API (markdown)

IgorTimofeev 2019-01-09 15:24:43 +03:00
parent 33eb7e1c6f
commit 204e486e08
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Text-API.md

@ -1,5 +1,14 @@
This library allows to work with text data in different ways: to serialize/deserialize tables, to wrap and limit strings, to obtain Braille font chars or to search data in `UTF-8` format.
| Contents |
| - |
| [  text.serialize](#textserializetable-table-boolean-pretty-int-recursiondepth-string-indentator-string-result) |
| [  text.deserialize](#textdeserializestring-serializedtable-table-or-nil-result-string-reason) |
| [  text.wrap](#textwrapstring-or-table-value-int-wrapwidth-table-result) |
| [  text.limit](#textlimitstring-value-int-width-string-mode-boolean-nodots---string--result) |
| [  text.brailleChar](#textbraillecharvar-a-var-b-var-c-boolean-d-var-e-var-f-var-g-var-h--string--result) |
| [  text.unicodeFind](#textunicodefind--) |
### text.**serialize**(*table* table[, *boolean* pretty, *int* recursionDepth, *string* indentator]): *string* result
Serializes given table to a string. If `pretty` argument is passed then serialization result will be more human-readable, by default it's set to `false`. Notice that `pretty` argument performs several additional checks on the type of keys and table values, and also generates the line break after each value. Therefore, use it only if the readability of the result is in priority over performance.