Function zipSync

Synchronous version of zip. Zips a file or directory.

Param: sourcePath

The path to zip.

Param: zipFilePath

Optional destination zip file path or options.

Param: options

Optional zip options.

Returns

An IOResult containing the result.

See

zip for the async version.

Since

1.6.0

zipSync(
    sourcePath: string,
    zipFilePath: string,
    options?: ZipOptions,
): VoidIOResult
Synchronous version of zip. Zips a file or directory and writes to a zip file.
Parameters
- sourcePath: string
  The path to zip.
- zipFilePath: string
  The destination zip file path.
- Optionaloptions: ZipOptions
  Optional zip options.
Returns VoidIOResult
A VoidIOResult indicating success or failure.
See
zip for the async version.

Since
1.6.0
Example
```
zipSync('/documents', '/backups/documents.zip');
```
- Defined in sync/ops.ts:595
zipSync(
sourcePath: string,
options?: ZipOptions,
): IOResult<Uint8Array<ArrayBuffer>>
Synchronous version of zip. Zips a file or directory and returns the zip data.
Parameters
- sourcePath: string
  The path to zip.
- Optionaloptions: ZipOptions
  Optional zip options.
Returns IOResult<Uint8Array<ArrayBuffer>>
An IOResult containing the zip data as Uint8Array.
See
zip for the async version.

Since
1.6.0
Example
```
zipSync('/documents')
    .inspect(data => console.log('Zip size:', data.byteLength));
```
- Defined in sync/ops.ts:611