Skip to Content
Skip to Content
API Referenceserde

Serializer/Deserializer

zune.serde

A library to serialize and deserialize data in luau.

Namespaces

json

PROPERTIES

indents

Indentation levels for JSON.

json.indents: <<table> = {
    none: number,
    two_spaces: number,
    four_spaces: number,
    tabs: number, 
}table<table> = {
    none: number,
    two_spaces: number,
    four_spaces: number,
    tabs: number, 
}>

values

Special values for JSON.

json.values: <<table> = {
    null: any, 
}table<table> = {
    null: any, 
}>

FUNCTIONS

encode

Encodes a value to JSON.

json.encode(value: any, config: export type SerdeJsonEncodeConfig = {
    pretty_indent: number?, 
}SerdeJsonEncodeConfigexport type SerdeJsonEncodeConfig = {
    pretty_indent: number?, 
}?): string

Parameters

  • value: any - The value to encode.
  • config: SerdeJsonEncodeConfig? - The configuration for the encoding.
    • pretty_indent: number? - The indentation level for pretty printing
      • default: 0

Throws

  • Memory Error

decode

Decodes JSON.

json.decode(json: string, config: export type SerdeJsonDecodeConfig = {
    preserve_null: boolean?, 
}SerdeJsonDecodeConfigexport type SerdeJsonDecodeConfig = {
    preserve_null: boolean?, 
}?): any

Parameters

  • json: string - The JSON string to decode.
  • config: SerdeJsonDecodeConfig? - The configuration for the decoding.
    • preserve_null: boolean? - Whether to preserve null values
      • default: false

Throws

  • Memory Error

json5

PROPERTIES

indents

Indentation levels for JSON.

json5.indents: <<table> = {
    none: number,
    two_spaces: number,
    four_spaces: number,
    tabs: number, 
}table<table> = {
    none: number,
    two_spaces: number,
    four_spaces: number,
    tabs: number, 
}>

values

Special values for JSON.

json5.values: <<table> = {
    null: any, 
}table<table> = {
    null: any, 
}>

FUNCTIONS

encode

Encodes a value to JSON.

json5.encode(value: any, config: export type SerdeJsonEncodeConfig = {
    pretty_indent: number?, 
}SerdeJsonEncodeConfigexport type SerdeJsonEncodeConfig = {
    pretty_indent: number?, 
}?): string

Parameters

  • value: any - The value to encode.
  • config: SerdeJsonEncodeConfig? - The configuration for the encoding.
    • pretty_indent: number? - The indentation level for pretty printing
      • default: 0

Throws

  • Memory Error

decode

Decodes JSON.

json5.decode(json: string, config: export type SerdeJsonDecodeConfig = {
    preserve_null: boolean?, 
}SerdeJsonDecodeConfigexport type SerdeJsonDecodeConfig = {
    preserve_null: boolean?, 
}?): any

Parameters

  • json: string - The JSON string to decode.
  • config: SerdeJsonDecodeConfig? - The configuration for the decoding.
    • preserve_null: boolean? - Whether to preserve null values
      • default: false

Throws

  • Memory Error

toml

FUNCTIONS

encode

Encodes a table to TOML.

toml.encode(object: {[string]: any}): string

Parameters

  • object: {[string]: any} - The table to encode.

Throws

  • Memory Error

decode

Decodes TOML.

toml.decode(toml: string | buffer): {[string]: any}

Parameters

  • toml: string | buffer - The TOML string to decode.

Throws

  • Memory Error

yaml

FUNCTIONS

encode

Encodes a value to YAML.

yaml.encode(object: type YamlInput = string | number | boolean | {
    [string]: YamlInput
}YamlInputtype YamlInput = string | number | boolean | {
    [string]: YamlInput
}): string

Parameters

  • object: YamlInput - The value to encode.

Throws

  • Memory Error

decode

Decodes YAML.

yaml.decode(yaml: string | buffer): type YamlOuput = string | {
    [string]: YamlOuput
}YamlOuputtype YamlOuput = string | {
    [string]: YamlOuput
}

Parameters

  • yaml: string | buffer - The YAML string to decode.

Throws

  • Memory Error

base64

FUNCTIONS

encode

Encodes a string to Base64.

base64.encode(value: string): string
base64.encode(value: buffer): buffer
base64.encode(value: string | buffer): string | buffer

Parameters

  • value: string | buffer - The data to encode.

Throws

  • Memory Error

decode

Decodes a Base64 string.

base64.decode(base64: string): string
base64.decode(base64: string | buffer): string | buffer

Parameters

  • base64: string | string | buffer - The Base64 value to decode.

Throws

  • Memory Error

gzip

FUNCTIONS

compress

gzip.compress(raw: string, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string
gzip.compress(raw: buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): buffer
gzip.compress(raw: string | buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.
  • opts: SerdeGenericCompressionOptions? - The options for the compression.
    • level: number? - The compression level

Throws

  • Memory Error

decompress

gzip.decompress(compressed: string): string
gzip.decompress(compressed: buffer): buffer
gzip.decompress(compressed: string | buffer): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.

Throws

  • Memory Error

flate

FUNCTIONS

compress

flate.compress(raw: string, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string
flate.compress(raw: buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): buffer
flate.compress(raw: string | buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.
  • opts: SerdeGenericCompressionOptions? - The options for the compression.
    • level: number? - The compression level

Throws

  • Memory Error

decompress

flate.decompress(compressed: string): string
flate.decompress(compressed: buffer): buffer
flate.decompress(compressed: string | buffer): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.

Throws

  • Memory Error

zlib

FUNCTIONS

compress

zlib.compress(raw: string, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string
zlib.compress(raw: buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): buffer
zlib.compress(raw: string | buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.
  • opts: SerdeGenericCompressionOptions? - The options for the compression.
    • level: number? - The compression level

Throws

  • Memory Error

decompress

zlib.decompress(compressed: string): string
zlib.decompress(compressed: buffer): buffer
zlib.decompress(compressed: string | buffer): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.

Throws

  • Memory Error

brotli

FUNCTIONS

compress

brotli.compress(raw: string, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string
brotli.compress(raw: buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): buffer
brotli.compress(raw: string | buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.
  • opts: SerdeGenericCompressionOptions? - The options for the compression.
    • level: number? - The compression level

Throws

  • Memory Error

decompress

brotli.decompress(compressed: string): string
brotli.decompress(compressed: buffer): buffer
brotli.decompress(compressed: string | buffer): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.

Throws

  • Memory Error

zstd

FUNCTIONS

compress

zstd.compress(raw: string, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string
zstd.compress(raw: buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): buffer
zstd.compress(raw: string | buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.
  • opts: SerdeGenericCompressionOptions? - The options for the compression.
    • level: number? - The compression level

Throws

  • Memory Error

decompress

zstd.decompress(compressed: string): string
zstd.decompress(compressed: buffer): buffer
zstd.decompress(compressed: string | buffer): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.

Throws

  • Memory Error

lz4

FUNCTIONS

compress

lz4.compress(raw: string): string
lz4.compress(raw: buffer): buffer
lz4.compress(raw: string | buffer): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.

Throws

  • Memory Error

compressFrame

lz4.compressFrame(raw: string, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string
lz4.compressFrame(raw: buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): buffer
lz4.compressFrame(raw: string | buffer, opts: export type SerdeGenericCompressionOptions = {
    level: number?, 
}SerdeGenericCompressionOptionsexport type SerdeGenericCompressionOptions = {
    level: number?, 
}?): string | buffer

Parameters

  • raw: string | buffer - The data to compress. If raw is a buffer, the function will return a buffer instead of a string.
  • opts: SerdeGenericCompressionOptions? - The options for the compression.
    • level: number? - The compression level

Throws

  • Memory Error

decompress

lz4.decompress(compressed: string, size: number): string
lz4.decompress(compressed: buffer, size: number): buffer
lz4.decompress(compressed: string | buffer, size: number): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.
  • size: number - The size of the expected data.

Throws

  • Memory Error

decompressFrame

lz4.decompressFrame(compressed: string): string
lz4.decompressFrame(compressed: buffer): buffer
lz4.decompressFrame(compressed: string | buffer): string | buffer

Parameters

  • compressed: string | buffer - The compressed data to decompress.

Throws

  • Memory Error
Last updated on
luauio