New streamed json response

Author: Admin

src/Responses/StreamedJsonResponse.php

@@ -69,6 +69,79 @@
  *    {'id':17009,'value':'92.00','created_at':'2024-01-17 09:17:11','updated_at':null,'primary_key_identifier':'17009'}
  *    {'id':17008,'value':'87.00','created_at':'2024-01-17 09:17:11','updated_at':null,'primary_key_identifier':'17008'}
  *    ...
+ *
+ * Example javascript code to handle this response:
+ *
+ * <script>
+ *      function requestStream(e,form) {
+ *          e.preventDefault();
+ *          const outputElement = document.getElementById("streamed_operations_response");
+ *
+ *          outputElement.innerHTML = '';
+ *          fetch(form.action, {method:'post', headers: {
+ *                  'Accept': 'application/json'
+ *              }, body: new URLSearchParams(new FormData(form))})
+ *              .then(response => {
+ *                  const reader = response.body.getReader();
+ *                  const decoder = new TextDecoder();
+ *                  let receivedLength = 0;
+ *                  let leftOver = '';
+ *                  return new ReadableStream({
+ *                      start(controller) {
+ *                          function push() {
+ *                              reader.read().then(({ done, value }) => {
+ *                                  if (done) {
+ *                                      controller.close();
+ *                                      return;
+ *                                  }
+ *                                  receivedLength += value.length;
+ *                                  const chunk = decoder.decode(value, { stream: true });
+ *                                  chunk.split(/\n/).forEach(function (element) {
+ *                                      let row;
+ *                                      try {
+ *                                          row = JSON.parse(element);
+ *                                      } catch (e) {
+ *                                          console.log('e');
+ *                                          if (leftOver === '') {
+ *                                              leftOver = element;
+ *
+ *                                              return;
+ *                                          } else {
+ *                                              try {
+ *                                                  row = JSON.parse(leftOver + element);
+ *                                                  leftOver = '';
+ *                                              } catch (ex) {
+ *                                                  console.log('ex');
+ *                                                  leftOver += element;
+ *                                                  console.log('This leftOver should not happen: ' + leftOver);
+ *
+ *                                                  return;
+ *                                              }
+ *                                          }
+ *                                      }
+ *
+ *                                      let child = document.createElement('p');
+ *                                      child.innerHTML = JSON.stringify(row)
+ *                                      outputElement.appendChild(child);
+ *                                  });
+ *                                  controller.enqueue(value);
+ *                                  push();
+ *                              });
+ *                          }
+ *                          push();
+ *                      }
+ *                  });
+ *              })
+ *              .then(stream => new Response(stream))
+ *              .then(response => response.text())
+ *              .then(data => {
+ *                  console.log("Streaming complete");
+ *              })
+ *              .catch(error => {
+ *                  console.error("Streaming error:", error);
+ *              });
+ *      }
+ *  </script>
  */
 class StreamedJsonResponse extends StreamedResponse
 {