/ README.md
README.md
 1  # Desero
 2  
 3  Quickly write models to deserialize an object to another.
 4  
 5  ## Installation
 6  
 7  ```sh
 8  bun add desero
 9  ```
10  
11  ## Usage
12  
13  ```typescript
14  import { t, deserialize } from "desero";
15  
16  class MyModel {
17    public id = t.string();
18  }
19  
20  const data = deserialize(MyModel, { id: "hello world" })
21  //    ^ { id: "hello world" }
22  ```
23  
24  You can find more examples in the [`examples` directory](./examples/).
25  
26  ## Recipes
27  
28  ### Use `@rename` to rebind properties
29  
30  ```typescript
31  import { t, rename, deserialize } from "desero";
32  
33  class MyModel {
34    @rename("L")
35    public label = t.string();
36  }
37  
38  const data = deserialize(MyModel, { L: "hello world" });
39  data.label // = "hello world";
40  ```