From 204e486e08ffcfbc12eab3ef94812bb07667feac Mon Sep 17 00:00:00 2001 From: IgorTimofeev Date: Wed, 9 Jan 2019 15:24:43 +0300 Subject: [PATCH] Updated Text API (markdown) --- Text-API.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Text-API.md b/Text-API.md index 257d62e..da45082 100644 --- a/Text-API.md +++ b/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.