Skip to content

Commit

Permalink
fix(docs): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codingki committed Aug 16, 2023
1 parent 67d7b37 commit a4d438c
Show file tree
Hide file tree
Showing 7 changed files with 63 additions and 7 deletions.
4 changes: 2 additions & 2 deletions docs/docs/hooks/useCosmWasmClient.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# useClients

Hook to retrieve a CosmWasmClient.
Hook to retrieve a useCosmWasmClient.

#### Usage

```tsx
import { useCosmWasmClient } from "graz";

function App() {
const { data: client, isFetching, refetch, ... } = useStargateClient();
const { data: client, isFetching, refetch, ... } = useCosmWasmClient();

async function getAccountFromClient() {
return await client.getAccount("address")
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hooks/useCosmWasmSigningClient.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# useClients
# useCosmWasmSigningClient

Hook to retrieve a SigningCosmWasmClient.

Expand Down
56 changes: 56 additions & 0 deletions docs/docs/hooks/useCosmWasmTmSigningClient.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# useCosmWasmTmSigningClient

Hook to retrieve a SigningCosmWasmClient with tendermint client.

#### Usage

```tsx
import { useCosmWasmTmSigningClient } from "graz";

function App() {
const { data: signingClient, isFetching, refetch, ... } = useCosmWasmTmSigningClient({ type: "tm34" });

async function getAccountFromClient() {
return await client.getAccount("address")
}
}
```

#### Params

```tsx
args?: {
type: "tm34" | "tm37";
opts?: SigningCosmWasmClientOptions;
}
```

#### Return Value

```tsx
{
data: SigningStargateClient
dataUpdatedAt: number;
error: TError | null;
errorUpdatedAt: number;
failureCount: number;
errorUpdateCount: number;
isError: boolean;
isFetched: boolean;
isFetchedAfterMount: boolean;
isFetching: boolean;
isLoading: boolean;
isLoadingError: boolean;
isPaused: boolean;
isPlaceholderData: boolean;
isPreviousData: boolean;
isRefetchError: boolean;
isRefetching: boolean;
isStale: boolean;
isSuccess: boolean;
refetch:(options?: RefetchOptions & RefetchQueryFilters) => Promise<QueryObserverResult<SigningCosmWasmClient | null, unknown>>;
remove: () => void;
status: 'loading' | 'error' | 'success';
fetchStatus: 'fetching' | 'paused' | 'idle';
}
```
2 changes: 1 addition & 1 deletion docs/docs/hooks/useStargateClient.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# useClients
# useStargateClient

Hook to retrieve a StargateClient.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hooks/useStargateSigningClient.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# useClients
# useStargateSigningClient

Hook to retrieve a SigningStargateClient.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hooks/useStargateTmSigningClient.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# useClients
# useStargateTmSigningClient

Hook to retrieve a SigningStargateClient with tendermint client.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/hooks/useTendermintClient.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# useClients
# useTendermintClient

Hook to retrieve a TendermintClient.

Expand Down

0 comments on commit a4d438c

Please sign in to comment.