diff --git a/.changeset/mighty-carrots-tickle.md b/.changeset/mighty-carrots-tickle.md new file mode 100644 index 0000000000..31f4cf754f --- /dev/null +++ b/.changeset/mighty-carrots-tickle.md @@ -0,0 +1,9 @@ +--- +'@moralisweb3/common-streams-utils': minor +'@moralisweb3/common-aptos-utils': minor +'@moralisweb3/common-evm-utils': minor +'@moralisweb3/common-sol-utils': minor +'moralis': minor +--- + +**Breaking change**: All `format()` methods are deprecated now. diff --git a/packages/common/aptosUtils/src/dataTypes/AptosAddress/AptosAddress.ts b/packages/common/aptosUtils/src/dataTypes/AptosAddress/AptosAddress.ts index ddef76704a..8b50f51d5f 100644 --- a/packages/common/aptosUtils/src/dataTypes/AptosAddress/AptosAddress.ts +++ b/packages/common/aptosUtils/src/dataTypes/AptosAddress/AptosAddress.ts @@ -60,12 +60,9 @@ export class AptosAddress implements MoralisData { public constructor(public readonly address: string) {} /** - * Formats the address to hex format. - * Currently returns a string representing the address. - * @example address.format(); // "0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90" + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): MoralisDataFormatted { - // TODO: add `format` argument return this.address; } diff --git a/packages/common/aptosUtils/src/dataTypes/AptosNative/AptosNative.ts b/packages/common/aptosUtils/src/dataTypes/AptosNative/AptosNative.ts index cd4febb653..200bb28d22 100644 --- a/packages/common/aptosUtils/src/dataTypes/AptosNative/AptosNative.ts +++ b/packages/common/aptosUtils/src/dataTypes/AptosNative/AptosNative.ts @@ -102,12 +102,9 @@ export class AptosNative implements MoralisData { } /** - * Converts the AptosNative to a string. - * @returns the value of the AptosNative as a string - * @example `native.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): MoralisDataFormatted { - // TODO: add `format` argument return this.octas; } diff --git a/packages/common/aptosUtils/src/dataTypes/AptosNetwork/AptosNetwork.ts b/packages/common/aptosUtils/src/dataTypes/AptosNetwork/AptosNetwork.ts index b0574ad906..f52ee39538 100644 --- a/packages/common/aptosUtils/src/dataTypes/AptosNetwork/AptosNetwork.ts +++ b/packages/common/aptosUtils/src/dataTypes/AptosNetwork/AptosNetwork.ts @@ -97,12 +97,9 @@ export class AptosNetwork implements MoralisData { private constructor(public readonly network: AptosNetworkName) {} /** - * Formats the network to a specific format. - * Currently returns a string representing the network. - * @example network.format(); // "mainnet" + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): MoralisDataFormatted { - // TODO: add `format` argument return this.network; } diff --git a/packages/common/evmUtils/src/dataTypes/Erc20/Erc20.ts b/packages/common/evmUtils/src/dataTypes/Erc20/Erc20.ts index 6449351741..228d1d1ea1 100644 --- a/packages/common/evmUtils/src/dataTypes/Erc20/Erc20.ts +++ b/packages/common/evmUtils/src/dataTypes/Erc20/Erc20.ts @@ -108,13 +108,7 @@ export class Erc20Token implements MoralisDataObject { } /** - * Returns the token as JSON - * - * @returns the Erc20Token as a JSON object - * @example - * ```ts - * token.format(); - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/Erc20Approval/Erc20Approval.ts b/packages/common/evmUtils/src/dataTypes/Erc20Approval/Erc20Approval.ts index 035c2d9078..f9938ccb11 100644 --- a/packages/common/evmUtils/src/dataTypes/Erc20Approval/Erc20Approval.ts +++ b/packages/common/evmUtils/src/dataTypes/Erc20Approval/Erc20Approval.ts @@ -85,8 +85,7 @@ export class Erc20Approval implements MoralisDataObject { } /** - * @returns a JSON representation of the approval. - * @example approval.format() + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/Erc20Burn/Erc20Burn.ts b/packages/common/evmUtils/src/dataTypes/Erc20Burn/Erc20Burn.ts index 379c9b93a7..9b2c9bd638 100644 --- a/packages/common/evmUtils/src/dataTypes/Erc20Burn/Erc20Burn.ts +++ b/packages/common/evmUtils/src/dataTypes/Erc20Burn/Erc20Burn.ts @@ -83,8 +83,7 @@ export class Erc20Burn implements MoralisDataObject { } /** - * @returns a JSON representation of the burn. - * @example burn.format() + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/Erc20Mint/Erc20Mint.ts b/packages/common/evmUtils/src/dataTypes/Erc20Mint/Erc20Mint.ts index cffb840f6e..d7f7f53d22 100644 --- a/packages/common/evmUtils/src/dataTypes/Erc20Mint/Erc20Mint.ts +++ b/packages/common/evmUtils/src/dataTypes/Erc20Mint/Erc20Mint.ts @@ -84,8 +84,7 @@ export class Erc20Mint implements MoralisDataObject { } /** - * @returns a JSON representation of the mint. - * @example mint.format() + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/Erc20Transfer/Erc20Transfer.ts b/packages/common/evmUtils/src/dataTypes/Erc20Transfer/Erc20Transfer.ts index a677b92a56..d40ecd0758 100644 --- a/packages/common/evmUtils/src/dataTypes/Erc20Transfer/Erc20Transfer.ts +++ b/packages/common/evmUtils/src/dataTypes/Erc20Transfer/Erc20Transfer.ts @@ -91,8 +91,7 @@ export class Erc20Transfer implements MoralisDataObject { } /** - * @returns a JSON represention of the transfer. - * @example transfer.format() + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/Erc20Value/Erc20Value.ts b/packages/common/evmUtils/src/dataTypes/Erc20Value/Erc20Value.ts index 371e9224b9..3c68f943ec 100644 --- a/packages/common/evmUtils/src/dataTypes/Erc20Value/Erc20Value.ts +++ b/packages/common/evmUtils/src/dataTypes/Erc20Value/Erc20Value.ts @@ -156,9 +156,7 @@ export class Erc20Value implements MoralisData { }; /** - * Convert the value to a string - * @returns the value in string format - * @example value.format(); + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format(): string { return this.toString(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmBlock.ts b/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmBlock.ts index 2461011e1b..b01e5b09e7 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmBlock.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmBlock.ts @@ -107,11 +107,7 @@ export class EvmBlock implements MoralisDataObject { } /** - * @returns a JSON represention of the block. - * @example - * ``` - * block.format() - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmSimpleBlock.ts b/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmSimpleBlock.ts index afcc9b1926..c07dc58403 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmSimpleBlock.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmBlock/EvmSimpleBlock.ts @@ -94,11 +94,7 @@ export class EvmSimpleBlock implements MoralisDataObject { } /** - * @returns a JSON represention of the block. - * @example - * ``` - * block.format() - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmEvent/EvmEvent.ts b/packages/common/evmUtils/src/dataTypes/EvmEvent/EvmEvent.ts index b9417e8fe1..dd2f101145 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmEvent/EvmEvent.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmEvent/EvmEvent.ts @@ -117,8 +117,7 @@ export class EvmEvent implements MoralisDataObject { } /** - * @returns a JSON represention of the event. - * @example event.format() + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmInternalTransaction/EvmInternalTransaction.ts b/packages/common/evmUtils/src/dataTypes/EvmInternalTransaction/EvmInternalTransaction.ts index 1a4233e8dd..6c76dc5036 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmInternalTransaction/EvmInternalTransaction.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmInternalTransaction/EvmInternalTransaction.ts @@ -104,11 +104,7 @@ export class EvmInternalTransaction implements MoralisDataObject { } /** - * @returns a JSON represention of the transaction. - * @example - * ``` - * transaction.format() - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmNative/EvmNative.ts b/packages/common/evmUtils/src/dataTypes/EvmNative/EvmNative.ts index 416fc476f1..e71285d89d 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmNative/EvmNative.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmNative/EvmNative.ts @@ -153,9 +153,7 @@ export class EvmNative implements MoralisData { } /** - * Converts the EvmNative to a string. - * @returns the value of the EvmNative as a string - * @example `native.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): string { return this.toString(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmNft/EvmNft.ts b/packages/common/evmUtils/src/dataTypes/EvmNft/EvmNft.ts index 45d189ac05..6326cd3484 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmNft/EvmNft.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmNft/EvmNft.ts @@ -153,9 +153,7 @@ export class EvmNft implements MoralisDataObject { } /** - * Converts the EvmNft instance to a JSON object. - * @returns JSON object of the EvmNft instance - * @example `nft.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts b/packages/common/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts index 0a06167a09..80b6b01705 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmNftCollection/EvmNftCollection.ts @@ -90,11 +90,7 @@ export class EvmNftCollection implements MoralisDataObject { } /** - * @returns a JSON represention of the collection. - * @example - * ``` - * collection.format() - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmNftMedia/EvmNftMedia.ts b/packages/common/evmUtils/src/dataTypes/EvmNftMedia/EvmNftMedia.ts index 77eaaf17d1..bd37960c1c 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmNftMedia/EvmNftMedia.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmNftMedia/EvmNftMedia.ts @@ -81,8 +81,7 @@ export class EvmNftMedia implements MoralisDataObject { } /** - * @returns a JSON representation of the media. - * @example media.format() + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmNftMetadata/EvmNftMetadata.ts b/packages/common/evmUtils/src/dataTypes/EvmNftMetadata/EvmNftMetadata.ts index b7916c3519..61933ce08d 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmNftMetadata/EvmNftMetadata.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmNftMetadata/EvmNftMetadata.ts @@ -98,8 +98,7 @@ export class EvmNftMetadata implements MoralisDataObject { } /** - * @returns the data as JSON. - * @example metadata.format(); + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmSignature/EvmSignature.ts b/packages/common/evmUtils/src/dataTypes/EvmSignature/EvmSignature.ts index 8dd2247784..f9fd8d0b45 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmSignature/EvmSignature.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmSignature/EvmSignature.ts @@ -77,6 +77,9 @@ export class EvmSignature implements MoralisDataObject { }; } + /** + * @deprecated This method will be removed soon. To format the value, use one of the properties. + */ format() { return this.serialized; } diff --git a/packages/common/evmUtils/src/dataTypes/EvmTransaction/EvmTransaction.ts b/packages/common/evmUtils/src/dataTypes/EvmTransaction/EvmTransaction.ts index a3c705b97b..de9d6f9e9a 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmTransaction/EvmTransaction.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmTransaction/EvmTransaction.ts @@ -135,11 +135,7 @@ export class EvmTransaction implements MoralisDataObject { } /** - * @returns a JSON represention of the transaction. - * @example - * ``` - * transaction.format() - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/evmUtils/src/dataTypes/EvmTransactionLog/EvmTransactionLog.ts b/packages/common/evmUtils/src/dataTypes/EvmTransactionLog/EvmTransactionLog.ts index d312c531ce..688635aa38 100644 --- a/packages/common/evmUtils/src/dataTypes/EvmTransactionLog/EvmTransactionLog.ts +++ b/packages/common/evmUtils/src/dataTypes/EvmTransactionLog/EvmTransactionLog.ts @@ -93,13 +93,7 @@ export class EvmTransactionLog implements MoralisDataObject { } /** - * Converts the log to a JSON object. - * - * @returns the EvmTransactionLog as a JSON object - * @example - * ```ts - * log.format(); - * ``` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/solUtils/src/dataTypes/SolAddress/SolAddress.ts b/packages/common/solUtils/src/dataTypes/SolAddress/SolAddress.ts index 448e880def..c91fe926e0 100644 --- a/packages/common/solUtils/src/dataTypes/SolAddress/SolAddress.ts +++ b/packages/common/solUtils/src/dataTypes/SolAddress/SolAddress.ts @@ -44,12 +44,9 @@ export class SolAddress implements MoralisData { public constructor(public readonly address: string) {} /** - * Formats the address to a specific format. - * Currently returns a string representing the address. - * @example address.format(); // "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM" + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): MoralisDataFormatted { - // TODO: add `format` argument return this.address; } diff --git a/packages/common/solUtils/src/dataTypes/SolNative/SolNative.ts b/packages/common/solUtils/src/dataTypes/SolNative/SolNative.ts index 58457f000e..f2ea345124 100644 --- a/packages/common/solUtils/src/dataTypes/SolNative/SolNative.ts +++ b/packages/common/solUtils/src/dataTypes/SolNative/SolNative.ts @@ -96,9 +96,7 @@ export class SolNative implements MoralisData { } /** - * Converts the SolNative to a string. - * @returns the value of the SolNative as a string - * @example `native.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): MoralisDataFormatted { // TODO: add `format` argument diff --git a/packages/common/solUtils/src/dataTypes/SolNetwork/SolNetwork.ts b/packages/common/solUtils/src/dataTypes/SolNetwork/SolNetwork.ts index f3548c34f0..089fcebd0f 100644 --- a/packages/common/solUtils/src/dataTypes/SolNetwork/SolNetwork.ts +++ b/packages/common/solUtils/src/dataTypes/SolNetwork/SolNetwork.ts @@ -77,12 +77,9 @@ export class SolNetwork implements MoralisData { private constructor(public readonly network: SolNetworkName) {} /** - * Formats the network to a specific format. - * Currently returns a string representing the network. - * @example network.format(); // "mainnet" + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ public format(): MoralisDataFormatted { - // TODO: add `format` argument return this.network; } diff --git a/packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.ts b/packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.ts index 580d69d00f..5edf44926f 100644 --- a/packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.ts +++ b/packages/common/streamsUtils/src/dataTypes/EvmStream/EvmStream.ts @@ -108,9 +108,7 @@ export class EvmStream implements MoralisDataObject { } /** - * Converts the EvmStream instance to a JSON object. - * @returns JSON object of the EvmStream instance - * @example `evmStream.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/EvmStreamResult/EvmStreamResult.ts b/packages/common/streamsUtils/src/dataTypes/EvmStreamResult/EvmStreamResult.ts index 5c0c16d073..f46f4e0968 100644 --- a/packages/common/streamsUtils/src/dataTypes/EvmStreamResult/EvmStreamResult.ts +++ b/packages/common/streamsUtils/src/dataTypes/EvmStreamResult/EvmStreamResult.ts @@ -101,9 +101,7 @@ export class EvmStreamResult implements MoralisDataObject { } /** - * Converts the EvmStreamResult instance to a JSON object. - * @returns JSON object of the EvmStreamResult instance - * @example `evmStreamResult.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamErc20Approval/StreamErc20Approval.ts b/packages/common/streamsUtils/src/dataTypes/StreamErc20Approval/StreamErc20Approval.ts index 6ecd073637..c3e35a9779 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamErc20Approval/StreamErc20Approval.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamErc20Approval/StreamErc20Approval.ts @@ -119,9 +119,7 @@ export class StreamErc20Approval implements MoralisDataObject { } /** - * Converts the StreamErc20Approval instance to a JSON object. - * @returns JSON object of the StreamErc20Approval instance - * @example `erc20Approval.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamErc20Transfer/StreamErc20Transfer.ts b/packages/common/streamsUtils/src/dataTypes/StreamErc20Transfer/StreamErc20Transfer.ts index f0a26d04d0..e70f7352f9 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamErc20Transfer/StreamErc20Transfer.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamErc20Transfer/StreamErc20Transfer.ts @@ -119,9 +119,7 @@ export class StreamErc20Transfer implements MoralisDataObject { } /** - * Converts the StreamErc20Transfer instance to a JSON object. - * @returns JSON object of the StreamErc20Transfer instance - * @example `erc20Transfer.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamErc721Approval/StreamErc721Approval.ts b/packages/common/streamsUtils/src/dataTypes/StreamErc721Approval/StreamErc721Approval.ts index 6fc472485c..23452e5ae8 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamErc721Approval/StreamErc721Approval.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamErc721Approval/StreamErc721Approval.ts @@ -128,9 +128,7 @@ export class StreamErc721Approval implements MoralisDataObject { } /** - * Converts the StreamErc721Approval instance to a JSON object. - * @returns JSON object of the StreamErc721Approval instance - * @example `evmNftApproval.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamEvmInternalTransaction/StreamEvmInternalTransaction.ts b/packages/common/streamsUtils/src/dataTypes/StreamEvmInternalTransaction/StreamEvmInternalTransaction.ts index bb4b404172..8a64c6da49 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamEvmInternalTransaction/StreamEvmInternalTransaction.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamEvmInternalTransaction/StreamEvmInternalTransaction.ts @@ -112,9 +112,7 @@ export class StreamEvmInternalTransaction implements MoralisDataObject { } /** - * Converts the StreamEvmInternalTransaction instance to a JSON object. - * @returns JSON object of the StreamEvmInternalTransaction instance - * @example `evmInternalTransaction.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamEvmNftTransfer/StreamEvmNftTransfer.ts b/packages/common/streamsUtils/src/dataTypes/StreamEvmNftTransfer/StreamEvmNftTransfer.ts index da266b2ac5..bba1618cf4 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamEvmNftTransfer/StreamEvmNftTransfer.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamEvmNftTransfer/StreamEvmNftTransfer.ts @@ -128,9 +128,7 @@ export class StreamEvmNftTransfer implements MoralisDataObject { } /** - * Converts the StreamEvmNftTransfer instance to a JSON object. - * @returns JSON object of the StreamEvmNftTransfer instance - * @example `transfer.toJSON()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamEvmTransaction/StreamEvmTransaction.ts b/packages/common/streamsUtils/src/dataTypes/StreamEvmTransaction/StreamEvmTransaction.ts index 478b77b75e..6504d7eba7 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamEvmTransaction/StreamEvmTransaction.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamEvmTransaction/StreamEvmTransaction.ts @@ -149,9 +149,7 @@ export class StreamEvmTransaction implements MoralisDataObject { } /** - * Converts the StreamEvmTransaction instance to a JSON object. - * @returns JSON object of the StreamEvmTransaction instance - * @example `transaction.toJSON()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamEvmTransactionLog/StreamEvmTransactionLog.ts b/packages/common/streamsUtils/src/dataTypes/StreamEvmTransactionLog/StreamEvmTransactionLog.ts index e77f25b6a9..c84ef53204 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamEvmTransactionLog/StreamEvmTransactionLog.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamEvmTransactionLog/StreamEvmTransactionLog.ts @@ -114,9 +114,7 @@ export class StreamEvmTransactionLog implements MoralisDataObject { } /** - * Converts the StreamEvmTransactionLog instance to a JSON object. - * @returns JSON object of the StreamEvmTransactionLog instance - * @example `transactionLog.toJSON()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamNativeBalance/StreamNativeBalance.ts b/packages/common/streamsUtils/src/dataTypes/StreamNativeBalance/StreamNativeBalance.ts index 297c2cf63d..8a1b71fc92 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamNativeBalance/StreamNativeBalance.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamNativeBalance/StreamNativeBalance.ts @@ -67,9 +67,7 @@ export class StreamNativeBalance implements MoralisDataObject { } /** - * Converts the NativeBalance instance to a JSON object. - * @returns JSON object of the NativeBalance instance - * @example `nativeBalanceTrigger.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamSelector/StreamSelector.ts b/packages/common/streamsUtils/src/dataTypes/StreamSelector/StreamSelector.ts index 1e8b55c3b5..1de1835778 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamSelector/StreamSelector.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamSelector/StreamSelector.ts @@ -91,9 +91,7 @@ export class StreamSelector implements MoralisData { } /** - * Converts the StreamSelector instance to a JSON object. - * @returns JSON object of the StreamSelector instance - * @example `streamSelector.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.value; diff --git a/packages/common/streamsUtils/src/dataTypes/StreamTrigger/StreamTrigger.ts b/packages/common/streamsUtils/src/dataTypes/StreamTrigger/StreamTrigger.ts index a9d6772023..45abb0831c 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamTrigger/StreamTrigger.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamTrigger/StreamTrigger.ts @@ -153,9 +153,7 @@ export class StreamTrigger implements MoralisDataObject { } /** - * Converts the StreamTrigger instance to a JSON object. - * @returns JSON object of the StreamTrigger instance - * @example `streamTrigger.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON(); diff --git a/packages/common/streamsUtils/src/dataTypes/StreamTriggerOutput/StreamTriggerOutput.ts b/packages/common/streamsUtils/src/dataTypes/StreamTriggerOutput/StreamTriggerOutput.ts index da096d02c8..df5500cb83 100644 --- a/packages/common/streamsUtils/src/dataTypes/StreamTriggerOutput/StreamTriggerOutput.ts +++ b/packages/common/streamsUtils/src/dataTypes/StreamTriggerOutput/StreamTriggerOutput.ts @@ -104,9 +104,7 @@ export class StreamTriggerOutput implements MoralisDataObject { } /** - * Converts the StreamTriggerOutput instance to a JSON object. - * @returns JSON object of the StreamTriggerOutput instance - * @example `streamTriggerOutput.format()` + * @deprecated This method will be removed soon. To format the value, use one of the properties. */ format() { return this.toJSON();