Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5549b13

Browse files
jnsdlsjnsdls
authored
switch doc generation to monorepo (thirdweb-dev#266)
1 parent 95a4ea3 commit 5549b13

File tree

82 files changed

+454
-598
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+454
-598
lines changed

‎.gitmodules‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
[submodule "submodules/typescript"]
2-
path = submodules/typescript
3-
url = https://github.com/thirdweb-dev/typescript-sdk
4-
branch = main
5-
[submodule "submodules/react"]
6-
path = submodules/react
7-
url = https://github.com/thirdweb-dev/react
8-
branch = main
91
[submodule "submodules/contracts"]
102
path = submodules/contracts
113
url = https://github.com/thirdweb-dev/contracts
@@ -17,3 +9,6 @@
179
[submodule "submodules/go"]
1810
path = submodules/go
1911
url = https://github.com/thirdweb-dev/go-sdk.git
12+
[submodule "submodules/js"]
13+
path = submodules/js
14+
url = https://github.com/thirdweb-dev/js.git

‎docs/react/react.useactiveclaimcondition.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ export declare function useActiveClaimCondition<
4646
maxClaimable: string;
4747
}[]
4848
| undefined;
49-
quantityLimitPerTransaction: string;
5049
startTime: Date;
51-
price: import("ethers").BigNumber;
5250
currencyAddress: string;
51+
price: import("ethers").BigNumber;
5352
maxQuantity: string;
53+
quantityLimitPerTransaction: string;
5454
waitInSeconds: import("ethers").BigNumber;
5555
merkleRootHash: string | number[];
5656
availableSupply: string;
@@ -75,6 +75,6 @@ export declare function useActiveClaimCondition<
7575

7676
**Returns:**
7777

78-
import("@tanstack/react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }, unknown&gt;
78+
import("@tanstack/react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; startTime: Date; currencyAddress: string; price: import("ethers").BigNumber; maxQuantity: string; quantityLimitPerTransaction: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }, unknown&gt;
7979

8080
a response object with the currently active claim condition

‎docs/react/react.useclaimconditions.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ export declare function useClaimConditions<
4646
maxClaimable: string;
4747
}[]
4848
| undefined;
49-
quantityLimitPerTransaction: string;
5049
startTime: Date;
51-
price: import("ethers").BigNumber;
5250
currencyAddress: string;
51+
price: import("ethers").BigNumber;
5352
maxQuantity: string;
53+
quantityLimitPerTransaction: string;
5454
waitInSeconds: import("ethers").BigNumber;
5555
merkleRootHash: string | number[];
5656
availableSupply: string;
@@ -75,6 +75,6 @@ export declare function useClaimConditions<
7575

7676
**Returns:**
7777

78-
import("@tanstack/react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; quantityLimitPerTransaction: string; startTime: Date; price: import("ethers").BigNumber; currencyAddress: string; maxQuantity: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }\[\], unknown&gt;
78+
import("@tanstack/react-query").UseQueryResult&lt;{ snapshot?: { address: string; maxClaimable: string; }\[\] \| undefined; startTime: Date; currencyAddress: string; price: import("ethers").BigNumber; maxQuantity: string; quantityLimitPerTransaction: string; waitInSeconds: import("ethers").BigNumber; merkleRootHash: string \| number\[\]; availableSupply: string; currentMintSupply: string; currencyMetadata: { symbol: string; value: import("ethers").BigNumber; name: string; decimals: number; displayValue: string; }; }\[\], unknown&gt;
7979

8080
a response object with the list of claim conditions

‎docs/react/react.usecontract.md‎

Lines changed: 25 additions & 25 deletions
Large diffs are not rendered by default.

‎docs/react/react.usecontractcompilermetadata.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,29 +36,29 @@ export declare function useContractCompilerMetadata(
3636
[x: string]: any;
3737
type: string;
3838
name: string;
39-
outputs: {
39+
inputs: {
4040
[x: string]: any;
41+
stateMutability?: string | undefined;
4142
components?:
4243
| {
4344
[x: string]: any;
4445
type: string;
4546
name: string;
4647
}[]
4748
| undefined;
48-
stateMutability?: string | undefined;
4949
type: string;
5050
name: string;
5151
}[];
52-
inputs: {
52+
outputs: {
5353
[x: string]: any;
54+
stateMutability?: string | undefined;
5455
components?:
5556
| {
5657
[x: string]: any;
5758
type: string;
5859
name: string;
5960
}[]
6061
| undefined;
61-
stateMutability?: string | undefined;
6262
type: string;
6363
name: string;
6464
}[];
@@ -84,6 +84,6 @@ export declare function useContractCompilerMetadata(
8484

8585
**Returns:**
8686

87-
import("@tanstack/react-query").UseQueryResult&lt;{ name: string; metadata: Record&lt;string, any&gt;; abi: { \[x: string\]: any; type: string; name: string; outputs: { \[x: string\]: any; components?: { \[x: string\]: any; type: string; name: string; }\[\] \| undefined; stateMutability?: string \| undefined; type: string; name: string; }\[\]; inputs: { \[x: string\]: any; components?: { \[x: string\]: any; type: string; name: string; }\[\] \| undefined; stateMutability?: string \| undefined; type: string; name: string; }\[\]; }\[\]; info: { title?: string \| undefined; author?: string \| undefined; details?: string \| undefined; notice?: string \| undefined; }; licenses: string\[\]; } \| undefined, unknown&gt;
87+
import("@tanstack/react-query").UseQueryResult&lt;{ name: string; metadata: Record&lt;string, any&gt;; abi: { \[x: string\]: any; type: string; name: string; inputs: { \[x: string\]: any; stateMutability?: string \| undefined; components?: { \[x: string\]: any; type: string; name: string; }\[\] \| undefined; type: string; name: string; }\[\]; outputs: { \[x: string\]: any; stateMutability?: string \| undefined; components?: { \[x: string\]: any; type: string; name: string; }\[\] \| undefined; type: string; name: string; }\[\]; }\[\]; info: { title?: string \| undefined; author?: string \| undefined; details?: string \| undefined; notice?: string \| undefined; }; licenses: string\[\]; } \| undefined, unknown&gt;
8888

8989
a response object that includes the published metadata (name, abi, bytecode) of the contract

‎docs/react/react.useedition.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@ export default function Component() {
3131
}
3232
```
3333

34+
use `useContract()` instead
35+
3436
**Signature:**
3537

3638
```typescript
3739
export declare function useEdition(
3840
contractAddress?: string,
39-
): Edition | undefined;
41+
): import("@thirdweb-dev/sdk").Edition | undefined;
4042
```
4143

4244
## Parameters
@@ -47,4 +49,4 @@ export declare function useEdition(
4749

4850
**Returns:**
4951

50-
Edition \| undefined
52+
import("@thirdweb-dev/sdk").Edition \| undefined

‎docs/react/react.useeditiondrop.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@ export default function Component() {
3030
}
3131
```
3232

33+
use `useContract()` instead
34+
3335
**Signature:**
3436

3537
```typescript
3638
export declare function useEditionDrop(
3739
contractAddress?: string,
38-
): EditionDrop | undefined;
40+
): import("@thirdweb-dev/sdk").EditionDrop | undefined;
3941
```
4042

4143
## Parameters
@@ -46,4 +48,4 @@ export declare function useEditionDrop(
4648

4749
**Returns:**
4850

49-
EditionDrop \| undefined
51+
import("@thirdweb-dev/sdk").EditionDrop \| undefined

‎docs/react/react.usemarketplace.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@ export default function Component() {
3131
}
3232
```
3333

34+
use `useContract()` instead
35+
3436
**Signature:**
3537

3638
```typescript
3739
export declare function useMarketplace(
3840
contractAddress?: string,
39-
): Marketplace | undefined;
41+
): import("@thirdweb-dev/sdk").Marketplace | undefined;
4042
```
4143

4244
## Parameters
@@ -47,4 +49,4 @@ export declare function useMarketplace(
4749

4850
**Returns:**
4951

50-
Marketplace \| undefined
52+
import("@thirdweb-dev/sdk").Marketplace \| undefined

‎docs/react/react.usemintnftsupply.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ export declare function useMintNFTSupply(
7272
contract: Erc1155,
7373
): import("@tanstack/react-query").UseMutationResult<
7474
import("@thirdweb-dev/sdk").TransactionResultWithId<{
75+
supply: BigNumber;
7576
metadata: {
7677
[x: string]: import("@thirdweb-dev/sdk").Json;
7778
name?: string | number | undefined;
@@ -82,7 +83,6 @@ export declare function useMintNFTSupply(
8283
uri: string;
8384
id: BigNumber;
8485
};
85-
supply: BigNumber;
8686
}>,
8787
unknown,
8888
MintNFTSupplyParams,
@@ -98,6 +98,6 @@ export declare function useMintNFTSupply(
9898
9999
**Returns:**
100100
101-
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;{ metadata: { \[x: string\]: import("@thirdweb-dev/sdk").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external_url?: string \| null \| undefined; animation_url?: string \| null \| undefined; uri: string; id: BigNumber; }; supply: BigNumber; }&gt;, unknown, [MintNFTSupplyParams](./react.mintnftsupplyparams.md), unknown&gt;
101+
import("@tanstack/react-query").UseMutationResult&lt;import("@thirdweb-dev/sdk").TransactionResultWithId&lt;{ supply: BigNumber; metadata: { \[x: string\]: import("@thirdweb-dev/sdk").Json; name?: string \| number \| undefined; description?: string \| null \| undefined; image?: string \| null \| undefined; external_url?: string \| null \| undefined; animation_url?: string \| null \| undefined; uri: string; id: BigNumber; }; }&gt;, unknown, [MintNFTSupplyParams](./react.mintnftsupplyparams.md), unknown&gt;
102102
103103
a mutation object that can be used to mint a more supply of a token id to the provided wallet

‎docs/react/react.usemultiwrap.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,14 @@ export default function Component() {
3030
}
3131
```
3232

33+
use `useContract()` instead
34+
3335
**Signature:**
3436

3537
```typescript
3638
export declare function useMultiwrap(
3739
contractAddress?: string,
38-
): Multiwrap | undefined;
40+
): import("@thirdweb-dev/sdk").Multiwrap | undefined;
3941
```
4042

4143
## Parameters
@@ -46,4 +48,4 @@ export declare function useMultiwrap(
4648

4749
**Returns:**
4850

49-
Multiwrap \| undefined
51+
import("@thirdweb-dev/sdk").Multiwrap \| undefined

0 commit comments

Comments
 (0)