@spec compress(String.t()) :: binary()

Compresses the given String with the lz-string algorithm.

 iex> LZString.compress("hello, i am a 猫")
 <<5, 133, 48, 54, 96, 246, 3, 64, 4, 9, 107, 2, 24, 22, 217, 180, 53, 51, 144, 0>>

Compresses the given string and base64 encodes it.

iex> LZString.compress_base64("hello, i am a 猫")
"BYUwNmD2A0AECWsCGBbZtDUzkAA="

Compresses the given string and base64 encodes it, substituting uri-unsafe characters.

iex> LZString.compress_uri_encoded("hello, i am a 猫") "BYUwNmD2A0AECWsCGBbZtDUzkAA$"

Decodes the given "base64" string, giving a naked lz-string bitstring.

iex> LZString.decode_base64("BYUwNmD2A0AECWsCGBbZtDUzkA==") <<5, 133, 48, 54, 96, 246, 3, 64, 4, 9, 107, 2, 24, 22, 217, 180, 53, 51, 144, 0, 0>>

Decodes the given "uri encoded" base64 string, giving a naked lz-string bitstring.

iex> LZString.decode_uri_encoded("BYUwNmD2A0AECWsCGBbZtDUzkA$$") <<5, 133, 48, 54, 96, 246, 3, 64, 4, 9, 107, 2, 24, 22, 217, 180, 53, 51, 144, 0, 0>>

@spec decompress(binary()) :: String.t()

Decompresses the given binary with the lz-string algorithm.

iex> LZString.decompress(<<5, 133, 48, 54, 96, 246, 3, 64, 4, 9, 107, 2, 24, 22, 217, 180, 53, 51, 144, 0>>) "hello, i am a 猫"

Decompresses the given string after decoding lz-string's non-standard base64.

iex> LZString.decompress_base64("BYUwNmD2A0AECWsCGBbZtDUzkA==")
"hello, i am a 猫"

Decompresses the given "uri encoded" base64 compressed string.

iex> LZString.decompress_uri_encoded("BYUwNmD2A0AECWsCGBbZtDUzkAA$") "hello, i am a 猫"