From 8af5ddf8be531655504af4d35936e1ccb56f1811 Mon Sep 17 00:00:00 2001 From: Keichi Takahashi Date: Wed, 25 Feb 2026 23:51:42 +0900 Subject: [PATCH] Document that endianness setting also affects bit field extraction order Closes #289 --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index c2e17bd..f7181bb 100644 --- a/README.md +++ b/README.md @@ -348,6 +348,14 @@ const parser = new Parser() .int32("c"); ``` +This setting also affects the bit extraction order of +[bit field](#bit1-32name-options) methods (`bit1` to `bit32`). In big-endian +mode, bit fields are extracted from MSB to LSB. +In little-endian mode, bit fields are extracted from LSB to MSB. +If you need big-endian bit ordering while using little-endian +byte ordering, you can parse bit fields in a separate `Parser` with +`.endianness("big")` and embed it using `.nest()`. + ### namely(alias) Set an alias to this parser, so that it can be referred to by name in methods like `.array`, `.nest` and `.choice`, without the requirement to have an