yujunjun/strapi
1
0
Fork 0
mirror of https://github.com/strapi/strapi.git synced 2025-09-05 22:57:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

add running a transfer

Browse Source
This commit is contained in:
Ben Irvin 2023-06-08 15:12:19 +02:00
parent d0d692b447
commit 5e33a7cbfd
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/docs/docs/01-core/data-transfer/01-engine.md
View File

@ -127,4 +127,17 @@ Transforms allow you to manipulate the data that is sent from the source before
## Running a transfer ## Running a transfer
Running a transfer simply involves calling the asynchrounous engine.transfer() method.
```typescript
const engine = createTransferEngine(source, destination, options);
try {
await engine.transfer();
} catch (e) {
console.error('Something went wrong: ', e?.message);
}
```
Be aware that engine.transfer() throws on any fatal errors it encounters.
Note: The transfer engine (and the providers) current only support a single `engine.transfer()` and must be re-instantiated if intended to run multiple times. In the future it is expected to allow them to be used for multiple transfers in a row, but that usage is untested and will result in unpredictable behavior. Note: The transfer engine (and the providers) current only support a single `engine.transfer()` and must be re-instantiated if intended to run multiple times. In the future it is expected to allow them to be used for multiple transfers in a row, but that usage is untested and will result in unpredictable behavior.