diff --git a/typescript/support/src/index.ts b/typescript/support/src/index.ts index c8aee4c069..3ab38c8fa3 100644 --- a/typescript/support/src/index.ts +++ b/typescript/support/src/index.ts @@ -1,5 +1,7 @@ +export * from "./decompressHandlers"; +export * from "./parseChannel"; +export * from "./parseFlatbufferSchema"; export * from "./parseJsonSchema"; +export * from "./parseProtobufSchema"; export * from "./protobufDefinitionsToDatatypes"; export * from "./protobufDescriptors"; -export * from "./parseChannel"; -export * from "./decompressHandlers"; diff --git a/typescript/support/src/parseChannel.ts b/typescript/support/src/parseChannel.ts index 214caaadb8..f6d9912ad0 100644 --- a/typescript/support/src/parseChannel.ts +++ b/typescript/support/src/parseChannel.ts @@ -64,7 +64,13 @@ function parsedDefinitionsToDatatypes( return datatypes; } +/** + * Options to configure the behavior of {@link parseChannel}. + */ export type ParseChannelOptions = { + /** + * Options to configure the behavior of {@link parseProtobufSchema}. + */ protobuf?: ParseProtobufSchemaOptions; }; diff --git a/typescript/support/src/parseProtobufSchema.ts b/typescript/support/src/parseProtobufSchema.ts index bd8d8dfd4d..1e93d57062 100644 --- a/typescript/support/src/parseProtobufSchema.ts +++ b/typescript/support/src/parseProtobufSchema.ts @@ -4,6 +4,9 @@ import { FileDescriptorSet } from "@foxglove/protobufjs/ext/descriptor"; import { protobufDefinitionsToDatatypes, stripLeadingDot } from "./protobufDefinitionsToDatatypes"; import { MessageDefinitionMap } from "./types"; +/** + * Options to configure the behavior of {@link parseProtobufSchema}. + */ export type ParseProtobufSchemaOptions = { /** * A function that will be called with the root type after parsing the FileDescriptorSet. Used by