Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
H34D committed Feb 6, 2023
1 parent 6b38156 commit 8138b12
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 33 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Expand Up @@ -4,14 +4,21 @@ 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).

#### [v0.24.0-alpha.1](https://github.com/masa-finance/masa-react/compare/v0.23.4...v0.24.0-alpha.1)
#### [v0.24.0-alpha.1](https://github.com/masa-finance/masa-react/compare/v0.23.5...v0.24.0-alpha.1)

> 3 February 2023
- migrate to webpack, jest and eslint [`d3056af`](https://github.com/masa-finance/masa-react/commit/d3056af1cb1ac6f31bafe9026651f4e6399fac35)
- fix build [`6885bac`](https://github.com/masa-finance/masa-react/commit/6885bac3b41b069a9ce925222fc0b1b1e2ed0fb6)
- lint free [`50a28f8`](https://github.com/masa-finance/masa-react/commit/50a28f8e6f7c7324b44509454f57c6c66066a1f6)

#### [v0.23.5](https://github.com/masa-finance/masa-react/compare/v0.23.4...v0.23.5)

> 6 February 2023
- spring cleaning [`e0c3426`](https://github.com/masa-finance/masa-react/commit/e0c3426bc202b783a82ceea3c953f9f0998154e7)
- update changelog [`8fa88b2`](https://github.com/masa-finance/masa-react/commit/8fa88b2e79b7a34915f960d7df9835261364b4f3)

#### [v0.23.4](https://github.com/masa-finance/masa-react/compare/v0.23.3...v0.23.4)

> 6 February 2023
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
@@ -1,5 +1,5 @@
# Masa React
- v0.23.3 / [Exports](modules.md)
- v0.23.5 / [Exports](modules.md)

---

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

# Interface: ArweaveConfig

Expand Down
9 changes: 1 addition & 8 deletions docs/interfaces/MasaContextProviderProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v0.23.3](../README.md) / [Exports](../modules.md) / MasaContextProviderProps
- v0.23.5](../README.md) / [Exports](../modules.md) / MasaContextProviderProps

# Interface: MasaContextProviderProps

Expand All @@ -18,7 +18,6 @@
- [closeModal](MasaContextProviderProps.md#closemodal)
- [company](MasaContextProviderProps.md#company)
- [connect](MasaContextProviderProps.md#connect)
- [cookie](MasaContextProviderProps.md#cookie)
- [creditScores](MasaContextProviderProps.md#creditscores)
- [environment](MasaContextProviderProps.md#environment)
- [greens](MasaContextProviderProps.md#greens)
Expand Down Expand Up @@ -120,12 +119,6 @@ ___

___

### cookie

`Optional` **cookie**: `string`

___

### creditScores

`Optional` **creditScores**: ``null`` \| { `metadata?`: `ICreditScore` ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[]
Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/MasaShape.md
@@ -1,5 +1,5 @@
[# Masa React
- v0.23.3](../README.md) / [Exports](../modules.md) / MasaShape
- v0.23.5](../README.md) / [Exports](../modules.md) / MasaShape

# Interface: MasaShape

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/ModalProps.md
@@ -1,5 +1,5 @@
[# Masa React
- v0.23.3](../README.md) / [Exports](../modules.md) / ModalProps
- v0.23.5](../README.md) / [Exports](../modules.md) / ModalProps

# Interface: ModalProps

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

# Interface: SpinnerProps

Expand Down
37 changes: 18 additions & 19 deletions docs/modules.md
@@ -1,8 +1,8 @@
[# Masa React
- v0.23.3](README.md) / Exports
- v0.23.5](README.md) / Exports

# # Masa React
- v0.23.3
- v0.23.5

## Table of contents

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

### createNewMasa

**createNewMasa**(`newWallet`, `env`, `arweaveConfig?`, `cookie?`): ``null`` \| `default`
**createNewMasa**(`newWallet`, `env`, `arweaveConfig?`): ``null`` \| `default`

#### Parameters

Expand All @@ -174,7 +174,6 @@ ___
| `newWallet` | `any` |
| `env` | `string` |
| `arweaveConfig?` | [`ArweaveConfig`](interfaces/ArweaveConfig.md) |
| `cookie?` | `string` |

#### Returns

Expand Down Expand Up @@ -228,44 +227,44 @@ ___
| :------ | :------ |
| `creditScores` | `undefined` \| { `metadata?`: `ICreditScore` ; `tokenId`: `BigNumber` ; `tokenUri`: `string` }[] |
| `error` | `unknown` |
| `handleCreateCreditScore` | () => `Promise`<`undefined` \| `boolean`\> |
| `handleCreateCreditScore` | () => `void` |
| `isLoading` | `boolean` |
| `status` | ``"loading"`` \| ``"error"`` \| ``"idle"`` \| ``"success"`` |
| `status` | `string` |

___

### useDebounce

**useDebounce**(`value`, `delay`): `any`
**useDebounce**(`value`, `delay`): `string` \| `number`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `any` |
| `delay` | `any` |
| `value` | `string` \| `number` |
| `delay` | `number` |

#### Returns

`any`
`string` \| `number`

___

### useDebounceIfValue

**useDebounceIfValue**(`value`, `target`, `delay`): `any`
**useDebounceIfValue**(`value`, `target`, `delay`): `string` \| `number`

#### Parameters

| Name | Type |
| :------ | :------ |
| `value` | `any` |
| `target` | `any` |
| `delay` | `any` |
| `value` | `string` \| `number` |
| `target` | `string` \| `number` |
| `delay` | `number` |

#### Returns

`any`
`string` \| `number`

___

Expand Down Expand Up @@ -371,10 +370,10 @@ ___
| :------ | :------ |
| `error` | `unknown` |
| `isLoading` | `boolean` |
| `loggedIn` | `undefined` \| `boolean` |
| `login` | () => `Promise`<`void`\> |
| `logout` | (`callback?`: () => `void`) => `Promise`<`void`\> |
| `status` | ``"loading"`` \| ``"error"`` \| ``"idle"`` \| ``"success"`` |
| `loggedIn?` | `boolean` |
| `login` | () => `void` |
| `logout` | () => `void` |
| `status` | `string` |

___

Expand Down

0 comments on commit 8138b12

Please sign in to comment.