Skip to content

Commit 4298f4d

Browse files
committed
docs(README): remove emojis from section headers for consistency
1 parent 13288d9 commit 4298f4d

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Powerful and flexible TypeScript/JavaScript library for serialization and deserialization with decorators
1010

11-
## Features
11+
## Features
1212

1313
- 🎯 **Type-safe** - Convert JSON to strongly-typed class instances
1414
- 🎨 **Decorator-based** - Clean and intuitive API using TypeScript decorators
@@ -19,49 +19,49 @@ Powerful and flexible TypeScript/JavaScript library for serialization and deseri
1919
- 📝 **FormData Support** - Built-in conversion to FormData for file uploads
2020
-**Lightweight** - Minimal dependencies and small bundle size
2121

22-
## 📋 Table of Contents
22+
## Table of Contents
2323

2424
- [ts-serializable](#ts-serializable)
25-
- [Features](#-features)
26-
- [📋 Table of Contents](#-table-of-contents)
27-
- [🚀 Installation](#-installation)
28-
- [🎯 Quick Start](#-quick-start)
25+
- [Features](#features)
26+
- [Table of Contents](#table-of-contents)
27+
- [Installation](#installation)
28+
- [Quick Start](#quick-start)
2929
- [Why Use ts-serializable?](#why-use-ts-serializable)
30-
- [🎓 Core Concepts](#-core-concepts)
30+
- [Core Concepts](#core-concepts)
3131
- [Type Safety](#type-safety)
3232
- [Default Values](#default-values)
3333
- [Error Handling](#error-handling)
34-
- [🎨 Decorators](#-decorators)
34+
- [Decorators](#decorators)
3535
- [@jsonProperty](#jsonproperty)
3636
- [@jsonIgnore](#jsonignore)
3737
- [@jsonName](#jsonname)
3838
- [@jsonObject](#jsonobject)
39-
- [🔧 Advanced Usage](#-advanced-usage)
40-
- [🔧 Standalone Functions](#-standalone-functions)
41-
- [🐍 Naming Strategies](#-naming-strategies)
42-
- [⚙️ Configuration Settings](#️-configuration-settings)
43-
- [🎭 View Models and DTOs](#-view-models-and-dtos)
44-
- [📤 FormData Conversion](#-formdata-conversion)
39+
- [Advanced Usage](#advanced-usage)
40+
- [Standalone Functions](#standalone-functions)
41+
- [Naming Strategies](#naming-strategies)
42+
- [Configuration Settings](#configuration-settings)
43+
- [View Models and DTOs](#view-models-and-dtos)
44+
- [FormData Conversion](#formdata-conversion)
4545
- [Basic Usage](#basic-usage)
4646
- [Complex Object Graphs](#complex-object-graphs)
4747
- [With Custom Prefix](#with-custom-prefix)
4848
- [Appending to Existing FormData](#appending-to-existing-formdata)
4949
- [Special Type Handling](#special-type-handling)
50-
- [💡 Additional Features](#-additional-features)
50+
- [Additional Features](#additional-features)
5151
- [Deep Copy](#deep-copy)
5252
- [Nested Objects](#nested-objects)
5353
- [Arrays of Objects](#arrays-of-objects)
54-
- [📚 API Reference](#-api-reference)
54+
- [API Reference](#api-reference)
5555
- [Serializable Class Methods](#serializable-class-methods)
5656
- [Static Methods](#static-methods)
5757
- [Instance Methods](#instance-methods)
58-
- [Standalone Functions](#standalone-functions)
58+
- [Standalone Functions](#standalone-functions-1)
5959
- [Available Naming Strategies](#available-naming-strategies)
60-
- [🤝 Contributing](#-contributing)
61-
- [📄 License](#-license)
62-
- [🙏 Acknowledgments](#-acknowledgments)
60+
- [Contributing](#contributing)
61+
- [License](#license)
62+
- [Acknowledgments](#acknowledgments)
6363

64-
## 🚀 Installation
64+
## Installation
6565

6666
```bash
6767
npm install ts-serializable reflect-metadata
@@ -74,7 +74,7 @@ npm install ts-serializable reflect-metadata
7474
import "reflect-metadata";
7575
```
7676

77-
## 🎯 Quick Start
77+
## Quick Start
7878

7979
Here's a simple example to get you started:
8080

@@ -124,7 +124,7 @@ const user: User = User.fromJSON(jsonString);
124124
user.getFullName(); // ✅ Works perfectly and returns a string
125125
```
126126

127-
## 🎓 Core Concepts
127+
## Core Concepts
128128

129129
### Type Safety
130130

@@ -162,7 +162,7 @@ class StrictUser extends Serializable {
162162
}
163163
```
164164

165-
## 🎨 Decorators
165+
## Decorators
166166

167167
### @jsonProperty
168168

@@ -252,7 +252,7 @@ class User extends Serializable {
252252
}
253253
```
254254

255-
## 🔧 Advanced Usage
255+
## Advanced Usage
256256

257257
This example is written in TypeScript, but it also works in JavaScript (without type annotations).
258258

@@ -320,7 +320,7 @@ user.getFullName(); // works fine and returns a string
320320
user.getAge(); // works fine and returns a number
321321
```
322322

323-
## 🔧 Standalone Functions
323+
## Standalone Functions
324324

325325
The library provides standalone utility functions `fromJSON` and `toJSON` that can be used with any objects, not just classes that extend `Serializable`. This is useful when you want to use the serialization features without inheritance.
326326

@@ -486,7 +486,7 @@ console.log(jsonToSend);
486486
// }
487487
```
488488

489-
## 🐍 Naming Strategies
489+
## Naming Strategies
490490

491491
The library supports automatic conversion between different naming conventions, making it easy to work with APIs that use different naming styles. Supported strategies include:
492492

@@ -531,7 +531,7 @@ user.dateOfBirth?.toISOString() === json.date_of_birth; // true
531531
user.veryStrangePropertyName === json["very::strange::json:name"]; // true
532532
```
533533

534-
## ⚙️ Configuration Settings
534+
## Configuration Settings
535535

536536
You can customize serialization behavior at three levels:
537537

@@ -557,7 +557,7 @@ Supported settings:
557557
- **defaultValueHandling**, enum, default Ignore - ...coming soon.
558558
- **logLevel**, enum, default Warning - ...coming soon.
559559

560-
## 🎭 View Models and DTOs
560+
## View Models and DTOs
561561

562562
If you need to create view-models from DTO or entity models, you can add view-specific properties and mark them with `@jsonIgnore()` to exclude them from serialization.
563563

@@ -583,7 +583,7 @@ JSON.stringify(user);
583583
// Result: {"firstName":"","familyName":""}
584584
```
585585

586-
## 📤 FormData Conversion
586+
## FormData Conversion
587587

588588
When working with file uploads, converting files to JSON (base64) can freeze the UI for large files. The library provides built-in FormData conversion as a more efficient alternative.
589589

@@ -774,7 +774,7 @@ The FormData conversion handles different types intelligently:
774774

775775
**Note:** All decorators (`@jsonIgnore`, `@jsonName`, naming strategies) are respected during FormData conversion.
776776

777-
## 💡 Additional Features
777+
## Additional Features
778778

779779
### Deep Copy
780780

@@ -845,7 +845,7 @@ const team = Team.fromJSON(json);
845845
console.log(team.members[0] instanceof User); // true
846846
```
847847

848-
## 📚 API Reference
848+
## API Reference
849849

850850
### Serializable Class Methods
851851

@@ -919,14 +919,14 @@ console.log(team.members[0] instanceof User); // true
919919
- `PascalCaseNamingStrategy` - Converts to PascalCase
920920
- `KebabCaseNamingStrategy` - Converts to kebab-case
921921

922-
## 🤝 Contributing
922+
## Contributing
923923

924924
Contributions are welcome! Please feel free to submit a Pull Request.
925925

926-
## 📄 License
926+
## License
927927

928928
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
929929

930-
## 🙏 Acknowledgments
930+
## Acknowledgments
931931

932932
Special thanks to all contributors and users of this library.

0 commit comments

Comments
 (0)