Remove Method

Removes file(s) and/or folder(s) from the archive.

Syntax

archivewriter.remove(path, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Use this method to remove entries from the archive. Provide an archive-local pathvia the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).