> ## Documentation Index
> Fetch the complete documentation index at: https://docs.projectreal.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# lz4compress

> 使用 LZ4 block compression 压缩 Lua string 字节，并将 raw compressed bytes 作为 Lua string 返回。

<div className="real-function-page">
  ```lua theme={null}
  lz4compress(data: string): string
  ```

  ## 别名

  * `crypt.lz4compress`
  * `crypt.lz4.compress`
  * `lz4.compress`

  ## 参数

  <ParamField path={"data"} type={"string"} required>
    传递给 LZ4 block compression 的 Lua string 字节。
  </ParamField>

  ## 返回值

  <ResponseField name={"compressed"} type={"string"}>
    以 Lua string 返回的 raw compressed bytes。original size 不会存储在输出中。
  </ResponseField>

  ## 示例

  压缩 Lua string 字节，并通过传入 original size 还原。

  ```lua theme={null}
  local source = string.rep("Real Docs ", 100)
  local compressed = lz4compress(source)
  local restored = lz4decompress(compressed, #source)

  print(#source, #compressed, restored == source)
  ```
</div>