Skip to content

Commit 3113ee5

Browse files
committed
fix: update docs with beta and bridge tags
1 parent 95423cf commit 3113ee5

File tree

6 files changed

+18
-6
lines changed

6 files changed

+18
-6
lines changed

packages/thirdweb/package.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,6 @@
4040
"import": "./dist/esm/exports/chains.js",
4141
"default": "./dist/cjs/exports/chains.js"
4242
},
43-
"./universal": {
44-
"types": "./dist/types/exports/universal.d.ts",
45-
"import": "./dist/esm/exports/universal.js",
46-
"default": "./dist/cjs/exports/universal.js"
47-
},
4843
"./contract": {
4944
"types": "./dist/types/exports/contract.d.ts",
5045
"import": "./dist/esm/exports/contract.js",

packages/thirdweb/src/bridge/Buy.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ import type { PreparedQuote, Quote } from "./types/Quote.js";
5555
* @returns A promise that resolves to a non-finalized quote for the requested buy.
5656
*
5757
* @throws Will throw an error if there is an issue fetching the quote.
58+
* @bridge
59+
* @beta
5860
*/
5961
export async function quote(options: quote.Options): Promise<quote.Result> {
6062
const {
@@ -186,6 +188,8 @@ export declare namespace quote {
186188
* @returns A promise that resolves to a non-finalized quote for the requested buy.
187189
*
188190
* @throws Will throw an error if there is an issue fetching the quote.
191+
* @bridge
192+
* @beta
189193
*/
190194
export async function prepare(
191195
options: prepare.Options,

packages/thirdweb/src/bridge/Routes.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ import type { Route } from "./types/Route.js";
9999
* @returns A promise that resolves to an array of routes.
100100
*
101101
* @throws Will throw an error if there is an issue fetching the routes.
102+
* @bridge
103+
* @beta
102104
*/
103105
export async function routes(options: routes.Options): Promise<routes.Result> {
104106
const {

packages/thirdweb/src/bridge/Sell.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,14 @@ import type { PreparedQuote, Quote } from "./types/Quote.js";
4949
* @param options.originTokenAddress - The address of the origin token.
5050
* @param options.destinationChainId - The chain ID of the destination token.
5151
* @param options.destinationTokenAddress - The address of the destination token.
52-
+ * @param options.sellAmountWei - The amount of the origin token to sell.
52+
* @param options.sellAmountWei - The amount of the origin token to sell.
5353
* @param options.client - Your thirdweb client.
5454
*
5555
* @returns A promise that resolves to a non-finalized quote for the requested sell.
5656
*
5757
* @throws Will throw an error if there is an issue fetching the quote.
58+
* @bridge
59+
* @beta
5860
*/
5961
export async function quote(options: quote.Options): Promise<quote.Result> {
6062
const {
@@ -186,6 +188,8 @@ export declare namespace quote {
186188
* @returns A promise that resolves to a non-finalized quote for the requested buy.
187189
*
188190
* @throws Will throw an error if there is an issue fetching the quote.
191+
* @bridge
192+
* @beta
189193
*/
190194
export async function prepare(
191195
options: prepare.Options,

packages/thirdweb/src/bridge/Status.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ import type { Status } from "./types/Status.js";
8888
* @returns A promise that resolves to a status object for the transaction.
8989
*
9090
* @throws Will throw an error if there is an issue fetching the status.
91+
* @bridge
92+
* @beta
9193
*/
9294
export async function status(options: status.Options): Promise<status.Result> {
9395
const { transactionHash, chainId, client } = options;

packages/thirdweb/tsdoc.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@
5757
"tagName": "@buyCrypto",
5858
"syntaxKind": "block"
5959
},
60+
{
61+
"tagName": "@bridge",
62+
"syntaxKind": "block"
63+
},
6064
{
6165
"tagName": "@storage",
6266
"syntaxKind": "block"
@@ -112,6 +116,7 @@
112116
"@walletConnection": true,
113117
"@walletUtils": true,
114118
"@buyCrypto": true,
119+
"@bridge": true,
115120
"@storage": true,
116121
"@auth": true,
117122
"@utils": true,

0 commit comments

Comments
 (0)