> For the complete documentation index, see [llms.txt](https://golua.fatality.win/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://golua.fatality.win/documentation/namespaces/zip.md).

# Zip

zip namespace

## Functions

### create

```lua
zip.create()
```

#### Returns:

|                                           |                                              |
| :---------------------------------------: | :------------------------------------------: |
| [Value](/documentation/namespaces/zip.md) | [Datatype](/documentation/namespaces/zip.md) |
|                 zip object                |    [zip](/documentation/datatypes/zip.md)    |

### open

```lua
zip.open("some_directory")
```

|                                               |                                              |                                                 |
| :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: |
| [Parameter](/documentation/namespaces/zip.md) | [Datatype](/documentation/namespaces/zip.md) | [Description](/documentation/namespaces/zip.md) |
|                      path                     |                    string                    |                path to directory                |

#### Returns:

|                                           |                                              |
| :---------------------------------------: | :------------------------------------------: |
| [Value](/documentation/namespaces/zip.md) | [Datatype](/documentation/namespaces/zip.md) |
|                 zip object                |    [zip](/documentation/datatypes/zip.md)    |

### open\_stream

```lua
zip.open_stream(...)
```

|                                               |                                              |                                                 |
| :-------------------------------------------: | :------------------------------------------: | :---------------------------------------------: |
| [Parameter](/documentation/namespaces/zip.md) | [Datatype](/documentation/namespaces/zip.md) | [Description](/documentation/namespaces/zip.md) |
|                     stream                    |                 table of char                |                    zip stream                   |

#### Returns:

|                                           |                                              |
| :---------------------------------------: | :------------------------------------------: |
| [Value](/documentation/namespaces/zip.md) | [Datatype](/documentation/namespaces/zip.md) |
|                 zip object                |    [zip](/documentation/datatypes/zip.md)    |