# Extract

Extract the source file or folder to the destination folder using the specified format:

\- zip - gzip

The {@code overwrite} argument is used to overwrite the destination file if it already exists, else it will throw an exception. The default is {@code false}.

The {@code recurse} argument is used to extract the files recursively. The default is {@code true}.

The {@code filter} argument is used to filter the files to extract. It can be:

\- A string with a regular expression to match the file names. Example: ".\*\\\\.txt" - A Function/Lambda that receives the file name and returns a boolean. Example: (name) => name.endsWith(".txt")

The {@code entryPaths} argument is used to extract only the files that match the given paths. It can be a string or an array of strings with the paths to extract. Example: "folder1/file1.txt" or \["folder1/file1.txt", "folder2/file2.txt"]

## Method Signature

```
Extract(format=[string], source=[string], destination=[string], overwrite=[boolean], recurse=[boolean], filter=[any], entryPaths=[any])
```

### Arguments

| Argument      | Type      | Required | Description                                                                               | Default |
| ------------- | --------- | -------- | ----------------------------------------------------------------------------------------- | ------- |
| `format`      | `string`  | `true`   | The format to use for the compression: zip or gzip.                                       |         |
| `source`      | `string`  | `true`   | The absolute path to the source file or folder to compress.                               |         |
| `destination` | `string`  | `true`   | The absolute path with a file name to save as the compressed file. Extension is optional. |         |
| `overwrite`   | `boolean` | `false`  | Whether to overwrite the destination file if it already exists. Default is false.         | `false` |
| `recurse`     | `boolean` | `false`  | Whether to extract the files recursively. Default is true.                                | `true`  |
| `filter`      | `any`     | `false`  | A regular expression or a Function/Lambda to filter the files to extract.                 |         |
| `entryPaths`  | `any`     | `false`  | The paths to extract. It can be a string or an array of strings.                          |         |

## Examples

### Extract a zip-file

Extract a zip-file and save the data in the "output-directory".

```java
extract( "zip", "test.zip", "output-directory" );

```

### Extract a multiple zip-files via a directory

Extract all zip-files, which are stored in the "multiple-directory" and save the data in the "output-directory".

```java
extract( "zip", "multiple-directory", "output-directory" );

```

### Additional Examples

```java
extract( "zip", "D:\test.zip", "D:\zipresult" );

```

## Related

* [Compress](/boxlang-language/reference/built-in-functions/zip/compress.md)
* [IsZipFile](/boxlang-language/reference/built-in-functions/zip/iszipfile.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://boxlang.ortusbooks.com/boxlang-language/reference/built-in-functions/zip/extract.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.