Merge pull request #703 from zapier/jasonkotenko-patch-1

docs(cli): update z.cursor docs for how to handle reaching the end of the result set

docs/index.html

@@ -5576,8 +5576,8 @@ <h3 id="whats-the-deal-with-pagination-when-is-it-used-and-how-does-it-work">Wha
   );
 
   <span class="hljs-comment">// after fetching a page, set the returned cursor for the next page,</span>
-  <span class="hljs-comment">// or empty/null if this was the last one.</span>
-  <span class="hljs-keyword">await</span> z.cursor.set(response.nextPage);
+  <span class="hljs-comment">// or an empty string if the cursor is null</span>
+  <span class="hljs-keyword">await</span> z.cursor.set(response.nextPage ?? <span class="hljs-string">&apos;&apos;</span>);
 
   <span class="hljs-keyword">return</span> response.items;
 };

packages/cli/README.md

@@ -3524,8 +3524,8 @@ const perform = async (z, bundle) => {
   );
 
   // after fetching a page, set the returned cursor for the next page,
-  // or empty/null if this was the last one.
-  await z.cursor.set(response.nextPage);
+  // or an empty string if the cursor is null
+  await z.cursor.set(response.nextPage ?? '');
 
   return response.items;
 };

packages/cli/docs/index.html

@@ -5576,8 +5576,8 @@ <h3 id="whats-the-deal-with-pagination-when-is-it-used-and-how-does-it-work">Wha
   );
 
   <span class="hljs-comment">// after fetching a page, set the returned cursor for the next page,</span>
-  <span class="hljs-comment">// or empty/null if this was the last one.</span>
-  <span class="hljs-keyword">await</span> z.cursor.set(response.nextPage);
+  <span class="hljs-comment">// or an empty string if the cursor is null</span>
+  <span class="hljs-keyword">await</span> z.cursor.set(response.nextPage ?? <span class="hljs-string">&apos;&apos;</span>);
 
   <span class="hljs-keyword">return</span> response.items;
 };

packages/cli/snippets/paging-cursor.js

@@ -23,8 +23,8 @@ const perform = async (z, bundle) => {
   );
 
   // after fetching a page, set the returned cursor for the next page,
-  // or empty/null if this was the last one.
-  await z.cursor.set(response.nextPage);
+  // or an empty string if the cursor is null
+  await z.cursor.set(response.nextPage ?? '');
 
   return response.items;
 };