Updated doc

janwuesten · Jan 22, 2024 · 5f44347 · 5f44347
1 parent 43b8c8a
commit 5f44347
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -25,12 +25,12 @@ class Country extends Definable {
   countryCode: string = ""
 
   definition({ prop }: DefinableDefinition): void {
-    prop("name")
-      .useDeserializer<string>((data) => this.name = data ?? "")
-      .useSerializer<string>(() => this.name)
-    prop("countryCode")
-      .useDeserializer<string>((data) => this.countryCode = data ?? "")
-      .useSerializer<string>(() => this.countryCode)
+    prop<string>("name")
+      .useDeserializer((data) => this.name = data ?? "")
+      .useSerializer(() => this.name)
+    prop<string>("countryCode")
+      .useDeserializer((data) => this.countryCode = data ?? "")
+      .useSerializer(() => this.countryCode)
   }
 }
 

diff --git a/docs/docs/definable/base-class.mdx b/docs/docs/definable/base-class.mdx
@@ -46,7 +46,7 @@ class MyFirstClass extends Definable {
 
   //highlight-start
   definition({ prop }: DefinableDefinition): void {
-    prop("myFirstProperty")
+    prop<string>("myFirstProperty")
   }
   //highlight-end
 }
@@ -64,11 +64,11 @@ class MyFirstClass extends Definable {
   myFirstProperty: string = ""
 
   definition({ prop }: DefinableDefinition): void {
-    prop("myFirstProperty")
+    prop<string>("myFirstProperty")
     //highlight-start
-      .useSerializer<string>(() => this.myFirstProperty)
+      .useSerializer(() => this.myFirstProperty)
       // data will have the type "string | null"
-      .useDeserializer<string>((data) => this.myFirstProperty = data ?? "")
+      .useDeserializer((data) => this.myFirstProperty = data ?? "")
     //highlight-end
   }
 

diff --git a/docs/docs/definable/deserialize.mdx b/docs/docs/definable/deserialize.mdx
@@ -14,15 +14,15 @@ class Country extends Definable {
   population: number = 83200000
 
   definition({ prop }: DefinableDefinition): void {
-    prop("name")
-      .useDeserializer<string>((data) => this.name = data ?? "")
-      .useSerializer<string>(() => this.name)
-    prop("code")
-      .useDeserializer<string>((data) => this.code = data ?? "")
-      .useSerializer<string>(() => this.code)
-    prop("population")
-      .useDeserializer<number>((data) => this.population = data ?? 0)
-      .useSerializer<number>(() => this.population)
+    prop<string>("name")
+      .useDeserializer((data) => this.name = data ?? "")
+      .useSerializer(() => this.name)
+    prop<string>("code")
+      .useDeserializer((data) => this.code = data ?? "")
+      .useSerializer(() => this.code)
+    prop<number>("population")
+      .useDeserializer((data) => this.population = data ?? 0)
+      .useSerializer(() => this.population)
   }
 }
 ```

diff --git a/docs/docs/definable/events.mdx b/docs/docs/definable/events.mdx
@@ -36,10 +36,10 @@ class MyFirstClass extends Definable {
     })
   //highlight-end
 
-    prop("myFirstProperty")
-      .useSerializer<string>(() => this.myFirstProperty)
+    prop<string>("myFirstProperty")
+      .useSerializer(() => this.myFirstProperty)
       // data will have the type "string | null"
-      .useDeserializer<string>((data) => this.myFirstProperty = data ?? "")
+      .useDeserializer((data) => this.myFirstProperty = data ?? "")
   }
 
 }

diff --git a/docs/docs/definable/serialize.mdx b/docs/docs/definable/serialize.mdx
@@ -14,15 +14,15 @@ class Country extends Definable {
   population: number = 83200000
 
   definition({ prop }: DefinableDefinition): void {
-    prop("name")
-      .useDeserializer<string>((data) => this.name = data ?? "")
-      .useSerializer<string>(() => this.name)
-    prop("code")
-      .useDeserializer<string>((data) => this.code = data ?? "")
-      .useSerializer<string>(() => this.code)
-    prop("population")
-      .useDeserializer<number>((data) => this.population = data ?? 0)
-      .useSerializer<number>(() => this.population)
+    prop<string>("name")
+      .useDeserializer((data) => this.name = data ?? "")
+      .useSerializer(() => this.name)
+    prop<string>("code")
+      .useDeserializer((data) => this.code = data ?? "")
+      .useSerializer(() => this.code)
+    prop<number>("population")
+      .useDeserializer((data) => this.population = data ?? 0)
+      .useSerializer(() => this.population)
   }
 }
 ```

diff --git a/docs/docs/definable/validation.mdx b/docs/docs/definable/validation.mdx
@@ -24,9 +24,9 @@ class Country extends Definable {
   code: string = ""
 
   definition({ prop }: DefinableDefinition): void {
-    prop("code")
-      .useDeserializer<string>((data) => this.code = data ?? "")
-      .useSerializer<string>(() => this.code)
+    prop<string>("code")
+      .useDeserializer((data) => this.code = data ?? "")
+      .useSerializer(() => this.code)
   }
 }
 ```
@@ -41,7 +41,7 @@ class Country extends Definable {
   code: string = ""
 
   definition({ prop }: DefinableDefinition): void {
-    prop("code")
+    prop<string>("code")
       //highlight-start
       .useValidator(() => {
         if (!this.code) {
@@ -53,8 +53,8 @@ class Country extends Definable {
         return null
       })
       //highlight-end
-      .useDeserializer<string>((data) => this.code = data ?? "")
-      .useSerializer<string>(() => this.code)
+      .useDeserializer((data) => this.code = data ?? "")
+      .useSerializer(() => this.code)
   }
 }
 ```

diff --git a/test/extension.test.ts b/test/extension.test.ts
@@ -13,7 +13,7 @@ class BaseClass extends Definable {
 class ExtendedClass extends BaseClass {
   definition({ prop, event }: DefinableDefinition): void {
     super.definition({ prop, event })
-    prop("testProp")
+    prop<string>("testProp")
       .useSerializer(() => this.testProp.toUpperCase())
   }
 }