summaryrefslogtreecommitdiff
path: root/js/flatbuffers.js
diff options
context:
space:
mode:
authorWouter van Oortmerssen <wvo@google.com>2016-08-10 17:53:40 -0700
committerWouter van Oortmerssen <wvo@google.com>2016-08-10 17:53:40 -0700
commit18d67ed83bfd54de4d248f4650f5ff1900b1ed6b (patch)
tree9c54212f3bcbd614657bf6088e2b9a1e7258a154 /js/flatbuffers.js
parent205ddb175f259d8fd9bae1cbfaf88162996799aa (diff)
downloadflatbuffers-18d67ed83bfd54de4d248f4650f5ff1900b1ed6b.tar.gz
flatbuffers-18d67ed83bfd54de4d248f4650f5ff1900b1ed6b.tar.bz2
flatbuffers-18d67ed83bfd54de4d248f4650f5ff1900b1ed6b.zip
Clarified in the docs how to get to the serialized bytes.
This was a frequent source of confusion, since in all implementations the data doesn't start at offset 0 in the buffer. Change-Id: I045966e65928e9acd9def84e215914ecb5510653
Diffstat (limited to 'js/flatbuffers.js')
-rw-r--r--js/flatbuffers.js5
1 files changed, 2 insertions, 3 deletions
diff --git a/js/flatbuffers.js b/js/flatbuffers.js
index 511c9a21..69bb783e 100644
--- a/js/flatbuffers.js
+++ b/js/flatbuffers.js
@@ -238,9 +238,8 @@ flatbuffers.Builder.prototype.dataBuffer = function() {
};
/**
- * Get the ByteBuffer representing the FlatBuffer. Only call this after you've
- * called finish(). The actual data starts at the ByteBuffer's current position,
- * not necessarily at 0.
+ * Get the bytes representing the FlatBuffer. Only call this after you've
+ * called finish().
*
* @returns {Uint8Array}
*/