Skip to content
On this page

serialize

ts
function serialize<const T>(obj: plainObject<T>): string

Serializes the plain properties to a json-like format that is friendly to read.

Example

ts
obj.serialize({
    name: 'Paul',
    numberOfBands: 4,
    alive: true,
}) // '{ name: Paul, numberOfBands: 4, alive: true }'
ts
obj.serialize({
    empty: [],
    oneValue: [1],
    multiValue: [true, false, 'zaphod', 42n],
}) // '{ empty: , oneValue: 1, multiValue: true, false, zaphod, 42 }'
ts
class Dog {
    constructor(private readonly name: string) { }

    bark(): string {
        return `wolf! wolf! I'm ${this.name}!`;
    }
}

obj.serialize(
    new Dog('Rex') as unknown as plainObject
) // '{ name: Rex }'