Merge pull request #189 from xdamman/fix188

update docs for getRecords
ensdomains · Sep 6, 2024 · 32a28d1 · 32a28d1
2 parents 3716abb + 523195f
commit 32a28d1
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 20 deletions.
diff --git a/docs/index/function.createEnsPublicClient.md b/docs/index/function.createEnsPublicClient.md
@@ -473,11 +473,9 @@ const client = createPublicClient({
 }).extend(ensPublicActions)
 const result = await client.getRecords({
   name: 'ens.eth',
-  records: {
-    texts: ['com.twitter', 'com.github'],
-    coins: ['ETH'],
-    contentHash: true,
-  },
+  texts: ['com.twitter', 'com.github'],
+  coins: ['ETH'],
+  contentHash: true,
 })
 // { texts: [{ key: 'com.twitter', value: 'ensdomains' }, { key: 'com.github', value: 'ensdomains' }], coins: [{ id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }], contentHash: { protocolType: 'ipns', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' } }
 ```

diff --git a/docs/public/function.getRecords.md b/docs/public/function.getRecords.md
@@ -24,11 +24,9 @@ const client = createPublicClient({
 })
 const result = await getRecords(client, {
   name: 'ens.eth',
-  records: {
-    texts: ['com.twitter', 'com.github'],
-    coins: ['ETH'],
-    contentHash: true,
-  },
+  texts: ['com.twitter', 'com.github'],
+  coins: ['ETH'],
+  contentHash: true,
 })
 // { texts: [{ key: 'com.twitter', value: 'ensdomains' }, { key: 'com.github', value: 'ensdomains' }], coins: [{ id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }], contentHash: { protocolType: 'ipns', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' } }
 ```

diff --git a/packages/ensjs/src/clients/decorators/public.ts b/packages/ensjs/src/clients/decorators/public.ts
@@ -272,11 +272,9 @@ export type EnsPublicActions = {
    * }).extend(ensPublicActions)
    * const result = await client.getRecords({
    *   name: 'ens.eth',
-   *   records: {
-   *     texts: ['com.twitter', 'com.github'],
-   *     coins: ['ETH'],
-   *     contentHash: true,
-   *   },
+   *   texts: ['com.twitter', 'com.github'],
+   *   coins: ['ETH'],
+   *   contentHash: true,
    * })
    * // { texts: [{ key: 'com.twitter', value: 'ensdomains' }, { key: 'com.github', value: 'ensdomains' }], coins: [{ id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }], contentHash: { protocolType: 'ipns', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' } }
    */

diff --git a/packages/ensjs/src/functions/public/getRecords.ts b/packages/ensjs/src/functions/public/getRecords.ts
@@ -469,11 +469,9 @@ type BatchableFunctionObject = {
  * })
  * const result = await getRecords(client, {
  *   name: 'ens.eth',
- *   records: {
- *     texts: ['com.twitter', 'com.github'],
- *     coins: ['ETH'],
- *     contentHash: true,
- *   },
+ *   texts: ['com.twitter', 'com.github'],
+ *   coins: ['ETH'],
+ *   contentHash: true,
  * })
  * // { texts: [{ key: 'com.twitter', value: 'ensdomains' }, { key: 'com.github', value: 'ensdomains' }], coins: [{ id: 60, name: 'ETH', value: '0xFe89cc7aBB2C4183683ab71653C4cdc9B02D44b7' }], contentHash: { protocolType: 'ipns', decoded: 'k51qzi5uqu5djdczd6zw0grmo23j2vkj9uzvujencg15s5rlkq0ss4ivll8wqw' } }
  */