Skip to content

Migration Guide ​

Server: Migrating to v2 ​

In v2, all functions and types with "InTransaction" in their name have been renamed to use "Tx" instead.

Function Renames ​

Old NameNew Name
getDocumentInTransactiongetDocumentTx
getDocumentInTransactionMaybegetDocumentMaybeTx
getDocumentDataInTransactiongetDocumentDataTx
getDocumentDataInTransactionMaybegetDocumentDataMaybeTx
getSpecificDocumentInTransactiongetSpecificDocumentTx
getSpecificDocumentInTransactionMaybegetSpecificDocumentMaybeTx
getSpecificDocumentDataInTransactionMaybegetSpecificDocumentDataMaybeTx
setDocumentInTransactionsetDocumentTx
setSpecificDocumentInTransactionsetSpecificDocumentTx
updateDocumentInTransactionupdateDocumentTx
updateDocumentWithPartialInTransactionupdateDocumentPartialTx
updateSpecificDocumentInTransactionupdateSpecificDocumentTx
updateSpecificDocumentWithPartialInTransactionupdateSpecificDocumentPartialTx
getDocumentsInTransactiongetDocumentsTx
getDocumentsDataInTransactiongetDocumentsDataTx
getFirstDocumentInTransactiongetFirstDocumentTx
getFirstDocumentDataInTransactiongetFirstDocumentDataTx

Type Renames ​

Old TypeNew Type
FsMutableDocumentInTransactionFsMutableDocumentTx

React Native: Deprecated Names ​

The following names are deprecated but still exported for backwards compatibility:

Deprecated NameUse Instead
getDocumentInTransactiongetDocumentTx
getDocumentInTransactionMaybegetDocumentMaybeTx
getSpecificDocumentFromTransactiongetSpecificDocumentTx
makeMutableDocumentInTransactionmakeMutableDocumentTx
FsMutableDocumentInTransactionFsMutableDocumentTx

Released under the Apache-2.0 License.