# HG changeset patch
# User Yaroslav Zhuravlev <yar@nginx.com>
# Date 1614862562 0
# Node ID a33d8f0f48b233f115f507bb2fd9824b02514e40
# Parent  e4d370d43176013f01bc66ec3e47f9599201e255
Documented r.done and r.sendBuffer in njs Reference.

diff --git a/xml/en/docs/njs/reference.xml b/xml/en/docs/njs/reference.xml
--- a/xml/en/docs/njs/reference.xml
+++ b/xml/en/docs/njs/reference.xml
@@ -9,7 +9,7 @@
 <article name="Reference"
         link="/en/docs/njs/reference.html"
         lang="en"
-        rev="61">
+        rev="62">
 
 <section id="summary">
 
@@ -50,6 +50,16 @@ All string properties of the object are
 request arguments object, read-only
 </tag-desc>
 
+<tag-name id="r_done"><literal>r.done()</literal></tag-name>
+<tag-desc>
+after calling this function,
+next data chunks will be passed to client without calling
+<link doc="../http/ngx_http_js_module.xml" id="js_body_filter"/>
+(<link doc="changes.xml" id="njs0.5.2">0.5.2</link>).
+May be called only from the
+<link doc="../http/ngx_http_js_module.xml" id="js_body_filter"/> function
+</tag-desc>
+
 <tag-name id="r_error"><literal>r.error(<value>string</value>)</literal></tag-name>
 <tag-desc>
 writes a <literal>string</literal> to the error log
@@ -304,6 +314,37 @@ The data sent can be a string or Buffer
 (<link doc="changes.xml" id="njs0.5.0">0.5.0</link>)
 </tag-desc>
 
+<tag-name id="r_sendbuffer"><literal>r.sendBuffer(<value>data</value>[,
+<value>options</value>])</literal></tag-name>
+<tag-desc>
+adds data to the chain of data chunks to be forwarded to the next body filter
+(<link doc="changes.xml" id="njs0.5.2">0.5.2</link>).
+The actual forwarding happens later,
+when the all the data chunks of the current chain are processed.
+<para>
+The data can be a string or Buffer.
+The <literal>options</literal> is an object used
+to override nginx buffer flags derived from an incoming data chunk buffer.
+The flags can be overridden with the following flags:
+<list type="tag">
+
+<tag-name><literal>last</literal></tag-name>
+<tag-desc>
+boolean,
+true if the buffer is the last buffer
+</tag-desc>
+
+<tag-name><literal>flush</literal></tag-name>
+<tag-desc>
+boolean,
+true if the buffer should have the <literal>flush</literal> flag
+</tag-desc>
+</list>
+</para>
+The method may be called only from the
+<link doc="../http/ngx_http_js_module.xml" id="js_body_filter"/> function.
+</tag-desc>
+
 <tag-name id="r_send_header"><literal>r.sendHeader()</literal></tag-name>
 <tag-desc>
 sends the HTTP headers to the client