Skip to content

Commit

Permalink
Update Client.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Madmaxs2 authored Nov 26, 2024
1 parent eff5e0e commit efa5686
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/hub-nodejs/docs/Client.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ successful response of type `<T>` or an error value. There are three types of re
- [MessagesResult<T>](#messagesresult)
- [FidsResult<T>](#fidsresult)

Results always return an object of type `Message` instead of a more specific type like `CastAddMessage` due to a quick of the protobuf-generated types. This can be easily remedied by passing responses through a typeguard:
Results always return an object of type `Message` instead of a more specific type like `CastAddMessage` due to a quirk of the protobuf-generated types. This can be easily remedied by passing responses through a typeguard:

```typescript
import { isCastAddMessage } from '@farcaster/hub-nodejs';
Expand Down Expand Up @@ -1137,7 +1137,7 @@ client.$.waitForReady(Date.now() + 5000, async (e) => {

A documentation alias for `HubAsyncResult<Message>` where the success value contains a single message.

Message are of the type <T> requested but this is an implicit guarantee since ts-proto does not generate bindings
Messages are of the type <T> requested but this is an implicit guarantee since ts-proto does not generate bindings
correctly to reflect this in the returned types.

---
Expand Down

0 comments on commit efa5686

Please sign in to comment.