(arrow-js) branch main updated: docs: Add RecordBatch class to rendered docs (#437)

[kou]

This is an automated email from the ASF dual-hosted git repository.

kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-js.git


The following commit(s) were added to refs/heads/main by this push:
     new 317fc12  docs: Add RecordBatch class to rendered docs (#437)
317fc12 is described below

commit 317fc120f63f1d6afdc0d0dd6ceac8cd2774b2d7
Author: Kyle Barron <k...@developmentseed.org>
AuthorDate: Mon May 18 22:47:58 2026 -0400

    docs: Add RecordBatch class to rendered docs (#437)
    
    ## What's Changed
    
    https://github.com/apache/arrow-js/pull/390 will fix the docs (on next
    publish) to include `Schema` and `Field` classes in the docs, but
    `RecordBatch` was still not published.
    
    This PR removes the `@ignore` tag, ensuring that the `RecordBatch` is
    generated and rendered:
    
    <img width="1441" height="898" alt="image"
    
src="https://github.com/user-attachments/assets/57a5efee-4ca7-4617-854a-9605beafd16b";
    />
---
 src/recordbatch.ts | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/recordbatch.ts b/src/recordbatch.ts
index f70c69f..58d1ace 100644
--- a/src/recordbatch.ts
+++ b/src/recordbatch.ts
@@ -46,7 +46,11 @@ export interface RecordBatch<T extends TypeMap = any> {
     [Symbol.isConcatSpreadable]: true;
 }
 
-/** @ignore */
+/**
+ * A RecordBatch is a collection of equal-length columns conforming to a
+ * particular {@link Schema}. A {@link Table} is composed of one or more
+ * RecordBatches.
+ */
 export class RecordBatch<T extends TypeMap = any> {
 
     /**