(arrow-js) branch main updated: fix: Fix missing Schema and Field classes from API Docs (#390)

[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 ed42d66  fix: Fix missing Schema and Field classes from API Docs (#390)
ed42d66 is described below

commit ed42d662c221f3748d75566bfa1ce3f13ee026a6
Author: Kent Wu <kent...@gmail.com>
AuthorDate: Wed Mar 4 21:31:35 2026 -0500

    fix: Fix missing Schema and Field classes from API Docs (#390)
    
    ## What's Changed
    
    This PR fixes an issue which causes `Schema` and `Field` to be excluded
    from the [public API
    docs](https://arrow.apache.org/js/current/modules/Arrow.node.html).
    
    The root cause is that this `declare module` block causes these to
    register as an exclusion. Everything else in this file is already
    explicitly ignored, so the config level exclusion is not necessary.
    
    ```ts
    // src/ipc/metadata/message.ts
    declare module '../../schema' {
        namespace Field {
            export { encodeField as encode };
            export { decodeField as decode };
            export { fieldFromJSON as fromJSON };
        }
        namespace Schema {
            export { encodeSchema as encode };
            export { decodeSchema as decode };
            export { schemaFromJSON as fromJSON };
        }
    }
    ```
    
    
    Closes #181.
    
    Co-authored-by: Kent Wu <k...@columnar.tech>
---
 typedoc.json | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/typedoc.json b/typedoc.json
index 2780bd3..74ee29c 100644
--- a/typedoc.json
+++ b/typedoc.json
@@ -9,7 +9,6 @@
     "includeVersion": true,
     "exclude": [
         "src/fb/*.ts",
-        "src/bin/*.ts",
-        "src/ipc/metadata/message.ts"
+        "src/bin/*.ts"
     ]
 }