diff --git a/API-Serialization.md b/API-Serialization.md new file mode 100644 index 0000000..78a3d16 --- /dev/null +++ b/API-Serialization.md @@ -0,0 +1,8 @@ +This module provides simple value serialization. + +- `serialization.serialize(value: any except functions[, pretty:boolean]): string` + Generates a string from an object that can be parsed again using `serialization.unserialize`. The generated output is Lua code. Supports basic types (nil, boolean, number, string) and tables without cycles (will error out when cycles are detected, unless in `pretty` print mode). Properly handles NaN values and infinity. + The `pretty` mode can be used to generate output for display to the user, this output will in most circumstances not be readable with `serialization.unserialize`. + This function can be useful for sending messages via a network card. +- `serialization.unserialize(value: string): any` + Restores an object previously saved with `serialization.serialize`. \ No newline at end of file