SyncFolderPullCommand

This interface is used to synchronize folders on the DID Space to local folders.
Parameter Type#Parameter Name
Type
Necessary
Default Value
Parameter Description
source``` → ```source
string
Y
-
The source folder that needs to be synchronized, please add a trailing slash `/` to the folder.
target
string
Y
-
Synchronize the source to the target folder, please add a trailing slash /
concurrency
number
N
256
Concurrency, default is 256.
retryCount
number
N
3
Retry 3 times after synchronization failure
debug
boolean
N
false
Output debug information
filter
function
N
Sync all files by default
Filter function, can be used to filter out certain directories or files
onProgress
function
N
-
Progress callback function
onAfterUpload
function
N
-
Callback function after upload completion
tmpDir
string
N
-
Temporary storage directory
Return type:#Field Name
Type
necessary
Parameter Description
statusCode
number
Y
Return Status Code
statusMessage
string
N
In general, there is only a value when an error occurs
stack
string
N
Stack Trace
data.errorCount
number
Y
Number of tasks that encountered an error
data.count
number
Y
Total number of tasks
data.duration
number
Y
Time spent, in seconds (s)

Example code:#Sync the folder of DID Spaces to local
const { SpaceClient, SyncFolderPullCommand } = require('@blocklet/did-space-js');
const getWallet = require('@blocklet/sdk/lib/wallet');

const spaceClient = new SpaceClient({
  endpoint,
  wallet: getWallet(),
});

const syncFolderPullCommand = new SyncFolderPullCommand({
  source: 'your_did_spaces/source_folder/',
  target: 'target_folder/',
  concurrency: 100,
  retryCount: 2,
  debug: true,
  filter: (object, index, objects) => {
    // filter logic here
  },
  onProgress: (input) => {
    // progress callback logic here
  },
  onAfterUpload: (input) => {
    // after upload callback logic here
  },
  tmpDir: 'temp/'
});

const result = await spaceClient.send(syncFolderPullCommand);

Welcome

User Guide

Developer guide

Reference Guide

Frequently Asked Questions

Change log

SyncFolderPullCommand

Parameter Type#

Return type:#

Example code:#

DeleteObjectCommand

Same text: SyncFolderPushCommand

Parameter Name	Type	Necessary	Default Value	Parameter Description
source``` → ```source	string	Y	-	The source folder that needs to be synchronized, please add a trailing slash `/` to the folder.
target	string	Y	-	Synchronize the source to the target folder, please add a trailing slash /
concurrency	number	N	256	Concurrency, default is 256.
retryCount	number	N	3	Retry 3 times after synchronization failure
debug	boolean	N	false	Output debug information
filter	function	N	Sync all files by default	Filter function, can be used to filter out certain directories or files
onProgress	function	N	-	Progress callback function
onAfterUpload	function	N	-	Callback function after upload completion
tmpDir	string	N	-	Temporary storage directory

Field Name	Type	necessary	Parameter Description
statusCode	number	Y	Return Status Code
statusMessage	string	N	In general, there is only a value when an error occurs
stack	string	N	Stack Trace
data.errorCount	number	Y	Number of tasks that encountered an error
data.count	number	Y	Total number of tasks
data.duration	number	Y	Time spent, in seconds (s)