Add includeTypedArrays option to generateTypeScript #128
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
snosenzo
reviewed
Sep 25, 2023
internal/generateTypeScript.ts
Outdated
| @@ -26,7 +41,15 @@ export const DURATION_TS = `export type Duration = { | |||
| }; | |||
| `; | |||
|
|
|||
| export function generateTypeScript(schema: FoxgloveSchema): string { | |||
| export type GenerateTypeScriptOptions = { | |||
| /** Include TypedArray types on numeric array fields, e.g. `number[] | Uint32Array` */ | |||
There was a problem hiding this comment.
Is it worth mentioning when it might be important to use this?
snosenzo
approved these changes
Sep 27, 2023
pezy
pushed a commit
to pezy/studio
that referenced
this pull request
Oct 25, 2023
…#6890) **User-Facing Changes** Fixed a type incompatibility issue with User Scripts that import from @foxglove/schemas. **Description** Fixes #6821 Fixes FG-4976 Depends on foxglove/schemas#128 Also updated JSON message datatype extraction to treat integer arrays as `Uint32Array` rather than `Float64Array`; this fixed a similar issue as #6821 with an example json-based mcap I had lying around.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Public-Facing Changes
Added an
includeTypedArraysoption togenerateTypeScriptto allow generating type definitions that include TypedArrays in addition to plainnumber[]arrays.Description
Relates FG-4976
See also https://github.com/foxglove/studio/pull/6890