docs: Add tuple enum JS client documentation (#2631)

coral-xyz · Sep 18, 2023 · fa9f960 · fa9f960 · vercel · Sep 18, 2023
1 parent b5f4796
commit fa9f960
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 71 deletions.
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/src/pages/docs/javascript-anchor-types.md b/docs/src/pages/docs/javascript-anchor-types.md
@@ -25,17 +25,17 @@ This reference shows you how anchor maps rust types to javascript/typescript typ
 * `u64/u128/i64/i128`
 * `anchor.BN`
 * ```javascript
-    await program
+  await program
     .methods
     .init(new anchor.BN(99))
     .rpc();
     ```
-* [https://github.com/indutny/bn.js/](https://github.com/indutny/bn.js/ )
+* [https://github.com/indutny/bn.js](https://github.com/indutny/bn.js )
 ---
 * `u8/u16/u32/i8/i16/i32`
 * `number`
 * ```javascript
-    await program
+  await program
     .methods
     .init(99)
     .rpc();
@@ -44,69 +44,79 @@ This reference shows you how anchor maps rust types to javascript/typescript typ
 * `f32/f64`
 * `number`
 * ```javascript
-    await program
+  await program
     .methods
     .init(1.0)
     .rpc();
     ```
 ---
 * `Enum`
-* `{ variantName: {} }`
-*   ```rust
-      enum MyEnum { One, Two };
-    ```
-    ```javascript
-    await program
+* `object`
+* ```rust
+  enum MyEnum {
+      One,
+      Two { val: u32 },
+      Three(u8, i16),
+  };
+  ```
+  ```javascript
+  // Unit variant
+  await program
     .methods
     .init({ one: {} })
     .rpc();
-    ```
-    ```rust
-    enum MyEnum { One: { val: u64 }, Two };
-    ```
-    ```javascript
-    await program
+
+  // Named variant
+  await program
     .methods
-    .init({ one: { val: 99 } })
+    .init({ two: { val: 99 } })
     .rpc();
-    ```
+
+  // Unnamed(tuple) variant
+  await program
+    .methods
+    .init({ three: [12, -34] })
+    .rpc();
+  ```
 ---
 * `Struct`
 * `{ val: {} }`
 * ```rust
-    struct MyStruct { val: u64 };
-    ```
+  struct MyStruct {
+    val: u16,
+  }
+  ```
   ```javascript
-    await program
+  await program
     .methods
     .init({ val: 99 })
     .rpc();
-    ```
+  ```
 ---
 * `[T; N]`
 * `[ T ]`
 * ```javascript
-    await program
+  await program
     .methods
-    .init([1,2,3])
+    .init([1, 2, 3])
     .rpc();
-    ```
+  ```
 ---
 * `String`
 * `string`
 * ```javascript
-    await program
+  await program
     .methods
     .init("hello")
     .rpc();
-    ```
+  ```
 ---
 * `Vec<T>`
 * `[ T ]`
 * ```javascript
-    await program
+  await program
     .methods
-    .init([1,2,3])
+    .init([1, 2, 3])
     .rpc();
-    ```
+  ```
 {% /table %}