Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
H34D committed Mar 7, 2023
1 parent 261c150 commit b9ee2fc
Show file tree
Hide file tree
Showing 9 changed files with 83 additions and 31 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Expand Up @@ -4,6 +4,31 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [v1.0.29](https://github.com/masa-finance/masa-react/compare/v1.0.28...v1.0.29)

> 7 March 2023
- metamask refactor [`2c9d487`](https://github.com/masa-finance/masa-react/commit/2c9d48777b399c127dc13d225d1e00fbc172c740)

#### [v1.0.28](https://github.com/masa-finance/masa-react/compare/v1.0.27...v1.0.28)

> 7 March 2023
- try to fix metamask handling [`2b8586c`](https://github.com/masa-finance/masa-react/commit/2b8586c6af2cedf5d6e64aa22d3fc7e345f951f2)

#### [v1.0.27](https://github.com/masa-finance/masa-react/compare/v1.0.26...v1.0.27)

> 7 March 2023
- refactor local storage access [`551695f`](https://github.com/masa-finance/masa-react/commit/551695fe1e745bea893aeb7db2ee3d4907ab15e7)

#### [v1.0.26](https://github.com/masa-finance/masa-react/compare/v1.0.25...v1.0.26)

> 7 March 2023
- update docs [`09618ce`](https://github.com/masa-finance/masa-react/commit/09618ce6db018fcd28fdd1ab7eedecbf8f5f301a)
- rework accounts loading [`b1b214d`](https://github.com/masa-finance/masa-react/commit/b1b214d3b6a7175441f34335618680469c9b2432)

#### [v1.0.25](https://github.com/masa-finance/masa-react/compare/v1.0.24...v1.0.25)

> 7 March 2023
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
@@ -1,5 +1,5 @@
# Masa React
- v1.0.25 / [Exports](modules.md)
- v1.0.29 / [Exports](modules.md)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ArweaveConfig.md
@@ -1,5 +1,5 @@
[# Masa React
- v1.0.25](../README.md) / [Exports](../modules.md) / ArweaveConfig
- v1.0.29](../README.md) / [Exports](../modules.md) / ArweaveConfig

# Interface: ArweaveConfig

Expand Down
34 changes: 19 additions & 15 deletions docs/interfaces/MasaContextProviderProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v1.0.25](../README.md) / [Exports](../modules.md) / MasaContextProviderProps
- v1.0.29](../README.md) / [Exports](../modules.md) / MasaContextProviderProps

# Interface: MasaContextProviderProps

Expand Down Expand Up @@ -33,8 +33,8 @@
- [handleLogout](MasaContextProviderProps.md#handlelogout)
- [handlePurchaseIdentity](MasaContextProviderProps.md#handlepurchaseidentity)
- [handlePurchaseIdentityWithSoulname](MasaContextProviderProps.md#handlepurchaseidentitywithsoulname)
- [hasWalletAddress](MasaContextProviderProps.md#haswalletaddress)
- [identity](MasaContextProviderProps.md#identity)
- [isConnected](MasaContextProviderProps.md#isconnected)
- [isCreditScoresLoading](MasaContextProviderProps.md#iscreditscoresloading)
- [isGreensLoading](MasaContextProviderProps.md#isgreensloading)
- [isIdentityLoading](MasaContextProviderProps.md#isidentityloading)
Expand Down Expand Up @@ -92,9 +92,9 @@ ___

### children

**children**: `ReactNode`
`Optional` **children**: `ReactNode`

#### Overrides
#### Inherited from

[MasaShape](MasaShape.md).[children](MasaShape.md#children)

Expand Down Expand Up @@ -128,7 +128,7 @@ ___

`Optional` **company**: `string`

#### Overrides
#### Inherited from

[MasaShape](MasaShape.md).[company](MasaShape.md#company)

Expand Down Expand Up @@ -369,6 +369,16 @@ ___

___

### hasWalletAddress

`Optional` **hasWalletAddress**: `boolean`

#### Inherited from

[MasaShape](MasaShape.md).[hasWalletAddress](MasaShape.md#haswalletaddress)

___

### identity

`Optional` **identity**: `Object`
Expand All @@ -386,16 +396,6 @@ ___

___

### isConnected

`Optional` **isConnected**: `boolean`

#### Inherited from

[MasaShape](MasaShape.md).[isConnected](MasaShape.md#isconnected)

___

### isCreditScoresLoading

`Optional` **isCreditScoresLoading**: `boolean`
Expand Down Expand Up @@ -734,6 +734,10 @@ ___

`Optional` **verbose**: `boolean`

#### Inherited from

[MasaShape](MasaShape.md).[verbose](MasaShape.md#verbose)

___

### walletAddress
Expand Down
23 changes: 15 additions & 8 deletions docs/interfaces/MasaShape.md
@@ -1,5 +1,5 @@
[# Masa React
- v1.0.25](../README.md) / [Exports](../modules.md) / MasaShape
- v1.0.29](../README.md) / [Exports](../modules.md) / MasaShape

# Interface: MasaShape

Expand Down Expand Up @@ -31,8 +31,8 @@
- [handleLogout](MasaShape.md#handlelogout)
- [handlePurchaseIdentity](MasaShape.md#handlepurchaseidentity)
- [handlePurchaseIdentityWithSoulname](MasaShape.md#handlepurchaseidentitywithsoulname)
- [hasWalletAddress](MasaShape.md#haswalletaddress)
- [identity](MasaShape.md#identity)
- [isConnected](MasaShape.md#isconnected)
- [isCreditScoresLoading](MasaShape.md#iscreditscoresloading)
- [isGreensLoading](MasaShape.md#isgreensloading)
- [isIdentityLoading](MasaShape.md#isidentityloading)
Expand All @@ -55,6 +55,7 @@
- [setProvider](MasaShape.md#setprovider)
- [soulnames](MasaShape.md#soulnames)
- [switchNetwork](MasaShape.md#switchnetwork)
- [verbose](MasaShape.md#verbose)
- [walletAddress](MasaShape.md#walletaddress)

## Properties
Expand Down Expand Up @@ -280,6 +281,12 @@ ___

___

### hasWalletAddress

`Optional` **hasWalletAddress**: `boolean`

___

### identity

`Optional` **identity**: `Object`
Expand All @@ -293,12 +300,6 @@ ___

___

### isConnected

`Optional` **isConnected**: `boolean`

___

### isCreditScoresLoading

`Optional` **isCreditScoresLoading**: `boolean`
Expand Down Expand Up @@ -533,6 +534,12 @@ ___

___

### verbose

`Optional` **verbose**: `boolean`

___

### walletAddress

`Optional` **walletAddress**: `string`
2 changes: 1 addition & 1 deletion docs/interfaces/ModalProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v1.0.25](../README.md) / [Exports](../modules.md) / ModalProps
- v1.0.29](../README.md) / [Exports](../modules.md) / ModalProps

# Interface: ModalProps

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/Network.md
@@ -1,5 +1,5 @@
[# Masa React
- v1.0.25](../README.md) / [Exports](../modules.md) / Network
- v1.0.29](../README.md) / [Exports](../modules.md) / Network

# Interface: Network

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/SpinnerProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v1.0.25](../README.md) / [Exports](../modules.md) / SpinnerProps
- v1.0.29](../README.md) / [Exports](../modules.md) / SpinnerProps

# Interface: SpinnerProps

Expand Down
22 changes: 19 additions & 3 deletions docs/modules.md
@@ -1,8 +1,8 @@
[# Masa React
- v1.0.25](README.md) / Exports
- v1.0.29](README.md) / Exports

# # Masa React
- v1.0.25
- v1.0.29

## Table of contents

Expand Down Expand Up @@ -41,6 +41,7 @@
- [useDebounceIfValue](modules.md#usedebounceifvalue)
- [useGreen](modules.md#usegreen)
- [useIdentity](modules.md#useidentity)
- [useLocalStorage](modules.md#uselocalstorage)
- [useMasa](modules.md#usemasa)
- [useMetamask](modules.md#usemetamask)
- [useModal](modules.md#usemodal)
Expand Down Expand Up @@ -331,6 +332,21 @@ ___

___

### useLocalStorage

**useLocalStorage**(): `Object`

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `localStorageGet` | <T\>(`key`: `string`) => `undefined` \| `T` |
| `localStorageSet` | <T\>(`key`: `string`, `value`: `T`) => `void` |

___

### useMasa

**useMasa**(): [`MasaShape`](interfaces/MasaShape.md)
Expand Down Expand Up @@ -482,7 +498,7 @@ ___
| Name | Type |
| :------ | :------ |
| `error` | `unknown` |
| `isConnected` | `boolean` |
| `hasWalletAddress` | `boolean` |
| `isWalletLoading` | `boolean` |
| `status` | `string` |
| `walletAddress` | `undefined` \| `string` |

0 comments on commit b9ee2fc

Please sign in to comment.