cede.compress

Compresses data using a compression algorithm.

Signature

function compress(algorithm: CompressionAlgorithm, plainData: string): string

Types

type CompressionAlgorithm = "lz4" | "zstd" | "deflate"

Summary

Parameters

Parameter	Type	Description
algorithm	CompressionAlgorithm	The compression algorithm to use.
plainData	string	The string data to compress.

Example

lz4

local cede = require("@std/cede")
local codec = require("@std/codec")

local compressed = cede.compress("lz4", "Hello, World!")

print(codec.encode(
    "base64",
    compressed
)) -- BCJNGEBw3w0AAIBIZWxsbywgV29ybGQhAAAAAA

zstd

local cede = require("@std/cede")
local codec = require("@std/codec")

local compressed = cede.compress("zstd", "Hello, World!")

print(codec.encode(
  "base64",
  compressed
)) -- 80jNycnXUQjPL8pJUQQA==

deflate

local cede = require("@std/cede")
local codec = require("@std/codec")

local compressed = cede.compress("deflate", "Hello, World!")

print(codec.encode(
  "base64",
  compressed
)) -- 80jN...