Skip to content

Commit e01b2b1

Browse files
Fix
1 parent 716d938 commit e01b2b1

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/pages/pipeline.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,15 @@ For this package to use your pipe it must extend the `BackupPipe` abstract which
3131
- `getKey` this is used for identifying when a specific driver should be should run.
3232
- `restore` which runs on restore, gets a path like this `path/to/backup/driver_key`.
3333
- `backup` runs on backup and it gets a zipper object you can use (zipper a zipArchive wrapper).
34-
- `skip` will mark the pipe as skipped, takes a zipper instance, next closure and a reason string.
3534

3635
## How it works
3736

3837
Since each backup pipe has a unique (it should be) key, it is pretty handy for the pipes to use this key to identify their backup files. For example, the `Content` pipe will backup to `path/to/backup/content` and the `Assets` pipe will backup to `path/to/backup/assets`.
3938

4039
Then when restoring, the pipe will get the path to the backup file and it can then use the key to identify its own backup file/dir. There is a helper method (`getDirectoryPath`) for that in the `BackupPipe` abstract.
4140

41+
When backing up and you want the pipe to be skipped, if for example if something doesn't exist, you can return the results of the `skip` method. `skip` takes a zipper instance, next closure and a reason string.
42+
4243
### Backing up
4344

4445
- Creates a zip archive

0 commit comments

Comments
 (0)