Skip to content

Commit fc2bccc

Browse files
committed
Flesh out doc [skip ci]
1 parent f94a410 commit fc2bccc

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

Source/Core/getJsonFromTypedArray.js

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
import getStringFromTypedArray from "./getStringFromTypedArray.js";
22

33
/**
4-
* @private
4+
* Parses JSON from a Uint8Array.
5+
*
56
* @function
6-
* @param {Uint8Array} uint8Array
7-
* @param {Number} byteOffset
8-
* @param {Number} byteLength
7+
*
8+
* @param {Uint8Array} uint8Array The Uint8Array to read from.
9+
* @param {Number} [byteOffset=0] The byte offset to start reading from.
10+
* @param {Number} [byteLength] The byte length to read. If byteLength is omitted the remainder of the buffer is read.
11+
* @returns {Object} An object containing the parsed JSON.
12+
*
13+
* @private
914
*/
1015
function getJsonFromTypedArray(uint8Array, byteOffset, byteLength) {
1116
return JSON.parse(

Source/Core/getStringFromTypedArray.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ import DeveloperError from "./DeveloperError.js";
44
import RuntimeError from "./RuntimeError.js";
55

66
/**
7+
* Reads a string from a Uint8Array.
8+
*
9+
* @function
10+
*
11+
* @param {Uint8Array} uint8Array The Uint8Array to read from.
12+
* @param {Number} [byteOffset=0] The byte offset to start reading from.
13+
* @param {Number} [byteLength] The byte length to read. If byteLength is omitted the remainder of the buffer is read.
14+
* @returns {String} The string.
15+
*
716
* @private
817
*/
918
function getStringFromTypedArray(uint8Array, byteOffset, byteLength) {

0 commit comments

Comments
 (0)