Skip to content

Commit ed42d66

Browse files
kentkwuKent Wu
andauthored
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 <kent@columnar.tech>
1 parent f43c01d commit ed42d66

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

typedoc.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
"includeVersion": true,
1010
"exclude": [
1111
"src/fb/*.ts",
12-
"src/bin/*.ts",
13-
"src/ipc/metadata/message.ts"
12+
"src/bin/*.ts"
1413
]
1514
}

0 commit comments

Comments
 (0)