changeset 2211:660229c5c92f

Documented String.bytesFrom() method in njs.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 31 Jul 2018 16:41:06 +0300
parents da8e5d713962
children c34a885b9d99
files xml/en/docs/njs/njs_api.xml
diffstat 1 files changed, 19 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/njs/njs_api.xml	Thu Jul 12 21:40:25 2018 +0300
+++ b/xml/en/docs/njs/njs_api.xml	Tue Jul 31 16:41:06 2018 +0300
@@ -9,7 +9,7 @@
 <article name="njs API"
         link="/en/docs/njs/njs_api.html"
         lang="en"
-        rev="3">
+        rev="4">
 
 <section id="summary">
 
@@ -71,6 +71,24 @@
 
 <list type="tag">
 
+<tag-name id="string_bytesfrom"><literal>String.bytesFrom(<value>array</value>
+| <value>string</value>, <value>encoding</value>)</literal></tag-name>
+<tag-desc>
+(njs specific) Creates a byte string either from an array that contains octets,
+or from an encoded string (0.2.3).
+The encoding can be
+<literal>hex</literal>,
+<literal>base64</literal>, and
+<literal>base64url</literal>.
+<example>
+>> String.bytesFrom([0x62, 0x75, 0x66, 0x66, 0x65, 0x72])
+'buffer'
+
+>> String.bytesFrom('YnVmZmVy', 'base64')
+'buffer'
+</example>
+</tag-desc>
+
 <tag-name><literal>String.fromCodePoint(<value>codePoint1</value>[, ...[,
 <value>codePoint2</value>]])</literal></tag-name>
 <tag-desc>