Skip to content

Update README to include legacyArrayMode #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pryhoda merged 1 commit into from
May 20, 2026
+11 −0
Merged

Update README to include legacyArrayMode #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ const { messages, errors } = decoder.read({
decodeMemoGlobs: false,
skipHeader: false,
dataOnly: false,
legacyArrayMode: false, // Deprecated
});
````
#### mesgListener = (messageNumber, message) => {}
Expand Down Expand Up @@ -193,6 +194,16 @@ When true, the decoder will read past the 14-byte header and ignore its contents
#### dataOnly: true | false
When true, the decoder will read the file as if the 14-byte header was not written. The decoder then assumes the file begins with a message definition and assumes file data size from the size of the file's stream.

#### legacyArrayMode: true | false *(Deprecated)*
legacyArrayMode is deprecated and will be removed by EOY 2026.

When false *(default)*, the decoder will adhere to the profile for array fields.

Array fields will always be returned as arrays, even when there is only one element
Non-array fields will always return a single value, even when there are multiple values
Setting legacyArrayMode option to true will revert to pre-v21.205 behavior


## Creating Streams
Stream objects contain the binary FIT data to be decoded. Stream objects can be created from byte-arrays, ArrayBuffers, and Node.js Buffers. Internally the Stream class uses an ArrayBuffer to manage the byte stream.
#### From a Byte Array
Expand Down
Loading