camelCase (#83)

Author: manzt

.changeset/itchy-paws-accept.md

@@ -0,0 +1,7 @@
+---
+"@zarrita/indexing": patch
+"@zarrita/ndarray": patch
+"@zarrita/core": patch
+---
+
+feat: prefer camelCase for public API

README.md

@@ -23,7 +23,7 @@ const store = new FetchStore("http://localhost:8080/data.zarr");
 const arr = await zarr.open.v2(store, { kind: "array" }); // zarr.Array<DataType, FetchStore>
 
 // read chunk
-const chunk = await arr.get_chunk([0, 0]);
+const chunk = await arr.getChunk([0, 0]);
 
 // Option 1: Builtin getter, no dependencies
 import { get, slice } from "@zarrita/indexing";
@@ -34,7 +34,7 @@ import { get } from "@zarrita/ndarray";
 const full = await get(arr); // ndarray.Ndarray<Int32Array>
 
 // read region
-const region = await get(arr, [null, zarr.slice(6)]);
+const region = await get(arr, [null, slice(6)]);
 ```
 
 ### Zarr building blocks

docs/get-started.md

@@ -13,7 +13,7 @@ const arr = await zarr.open.v2(store, { kind: "array" });
 ## Read a chunk
 
 ```js
-const chunk = await arr.get_chunk([0, 0]);
+const chunk = await arr.getChunk([0, 0]);
 // {
 //   data: Int32Array(10) [
 //      0,  1,  2,  3,  4,

docs/recipes.md

@@ -11,7 +11,7 @@ const arr = await zarr.open(store, { kind: "array" });
 
 arr; // zarr.Array<DataType, FetchStore>
 arr.shape; // [5, 10]
-arr.chunk_shape; // [2, 5]
+arr.chunks; // [2, 5]
 arr.dtype; // "int32"
 ```
 
@@ -74,8 +74,8 @@ import { FileSystemStore } from "@zarrita/storage";
 const store = new FileSystemStore("tempstore");
 const arr = await zarr.create(store, {
 	shape: [10, 10],
-	chunk_shape: [5, 5],
-	data_type: "int32",
+	chunks: [5, 5],
+	dtype: "int32",
 });
 arr; // zarr.Array<"int32", FileSystemStore>
 ```

packages/core/__tests__/create.test.ts

@@ -4,13 +4,13 @@ import * as zarr from "../src/index.js";
 import { json_decode_object } from "../src/util.js";
 
 test("create root group", async () => {
-	let h = zarr.root();
 	let attributes = { hello: "world" };
-	let grp = await zarr.create(h, { attributes });
+	let grp = await zarr.create(new Map(), { attributes });
 	expect(grp.path).toBe("/");
 	expect(await grp.attrs()).toStrictEqual(attributes);
-	expect(h.store.has("/zarr.json")).true;
-	expect(json_decode_object(h.store.get("/zarr.json")!)).toMatchInlineSnapshot(`
+	expect(grp.store.has("/zarr.json")).true;
+	expect(json_decode_object(grp.store.get("/zarr.json")!))
+		.toMatchInlineSnapshot(`
 		{
 		  "attributes": {
 		    "hello": "world",
@@ -34,7 +34,7 @@ test("create array", async () => {
 	expect(a.path).toBe("/arthur/dent");
 	expect(a.shape).toStrictEqual([5, 10]);
 	expect(a.dtype).toBe("int32");
-	expect(a.chunk_shape).toStrictEqual([2, 5]);
+	expect(a.chunks).toStrictEqual([2, 5]);
 	expect(await a.attrs()).toStrictEqual(attributes);
 	expect(json_decode_object(h.store.get("/arthur/dent/zarr.json")!))
 		.toMatchInlineSnapshot(`

packages/core/__tests__/hierarchy.test.ts

@@ -37,28 +37,21 @@ describe("Array", () => {
 		let arr = new Array(new Map(), "/", array_metadata);
 		expect({
 			shape: arr.shape,
-			chunk_shape: arr.chunk_shape,
+			chunks: arr.chunks,
 			dtype: arr.dtype,
-			fill_value: arr.fill_value,
 			attrs: await arr.attrs(),
 			path: arr.path,
-			codec: arr.codec,
 			store: arr.store,
 		}).toMatchInlineSnapshot(`
 			{
 			  "attrs": {
 			    "answer": 42,
 			  },
-			  "chunk_shape": [
+			  "chunks": [
 			    5,
 			    5,
 			  ],
-			  "codec": {
-			    "decode": [Function],
-			    "encode": [Function],
-			  },
 			  "dtype": "int8",
-			  "fill_value": 0,
 			  "path": "/",
 			  "shape": [
 			    10,