chore: update docs

PrismarineJS · Sep 8, 2024 · 9fc72b5 · 9fc72b5
1 parent ebac715
commit 9fc72b5
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -58,10 +58,18 @@ Minecraft Java Edition uses big-endian format, and Bedrock uses little-endian.
 
 Returns a buffer with a serialized nbt `value`. 
 
-### parseUncompressed(data, format='big')
+### parseUncompressed(data, format='big', options?= {noArraySizeCheck?: boolean})
 
 Takes a buffer `data` and returns a parsed nbt value.
 
+The `options` parameter is optional. When `noArraySizeCheck` is `true`, an array size check is disabled which allows for parsing of large arrays.
+
+### parseAs(data, type, options?= {noArraySizeCheck?: boolean})
+
+Takes a buffer `data` and returns a parsed nbt value. If the buffer is gzipped, it will unzip the data first.
+
+The `options` parameter is optional. When `noArraySizeCheck` is `true`, an array size check is disabled which allows for parsing of large arrays.
+
 
 ### simplify(nbt)
 

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -79,7 +79,7 @@ declare module 'prismarine-nbt'{
   }
   export function writeUncompressed(value: NBT, format?: NBTFormat): Buffer;
   export function parseUncompressed(value: Buffer, format?: NBTFormat, options?: ParseOptions): NBT;
-  export function parseAs(value: Buffer, format: NBTFormat, options?: ParseOptions): Promise<{parsed: NBT, type: NBTFormat, metadata: Metadata}>;
+  export function parseAs(value: Buffer, type: NBTFormat, options?: ParseOptions): Promise<{parsed: NBT, type: NBTFormat, metadata: Metadata}>;
 
   export function parse(data: Buffer, nbtType?: NBTFormat): Promise<{parsed: NBT, type: NBTFormat, metadata: Metadata}>;
   export function simplify(data: Tags[TagType]): any