docs: update docs deps and add new docs

nartc · Apr 7, 2021 · 16719ff · 16719ff
1 parent e2c1d99
commit 16719ff
Show file tree

Hide file tree

Showing 8 changed files with 197 additions and 190 deletions.
diff --git a/docs-site/docs/getting-started/introduce-to-automapper.md b/docs-site/docs/getting-started/introduce-to-automapper.md
@@ -138,12 +138,12 @@ export class User {
 
   password: string;
 
-  @AutoMap(() => Bio)
+  @AutoMap({ typeFn: () => Bio })
   bio: Bio;
 }
 
 export class Bio {
-  @AutoMap(() => Job)
+  @AutoMap({ typeFn: () => Job })
   job: Job;
 
   birthday: Date;
@@ -176,7 +176,7 @@ export class UserDto {
   @AutoMap()
   username: string;
 
-  @AutoMap(() => BioDto)
+  @AutoMap({ typeFn: () => BioDto })
   bio: BioDto;
 }
 
@@ -379,12 +379,12 @@ export class User {
 
   password: string;
 
-  @AutoMap(() => Bio)
+  @AutoMap({ typeFn: () => Bio })
   bio: Bio;
 }
 
 export class Bio {
-  @AutoMap(() => Job)
+  @AutoMap({ typeFn: () => Job })
   job: Job;
 
   birthday: Date;
@@ -413,7 +413,7 @@ export class UserDto {
   @AutoMap()
   username: string;
 
-  @AutoMap(() => BioDto)
+  @AutoMap({ typeFn: () => BioDto })
   bio: BioDto;
 }
 

diff --git a/docs-site/docs/mapping-configuration/auto.md b/docs-site/docs/mapping-configuration/auto.md
@@ -35,7 +35,7 @@ class Bar {
 class Foo {
   @AutoMap()
   foo: string;
-  @AutoMap(() => Bar)
+  @AutoMap({ typeFn: () => Bar })
   bar: Bar;
 }
 
@@ -112,7 +112,7 @@ export class Address {
 }
 
 export class User {
-  @AutoMap(() => Address)
+  @AutoMap({ typeFn: () => Address })
   addresses: Address[];
 }
 
@@ -122,7 +122,7 @@ export class AddressDto {
 }
 
 export class UserDto {
-  @AutoMap(() => AddressDto)
+  @AutoMap({ typeFn: () => AddressDto })
   addresses: AddressDto[];
 }
 ```
@@ -153,7 +153,7 @@ export enum UserRole {
 }
 
 export class User {
-  @AutoMap(() => String) // because UserRole is a string enum
+  @AutoMap({ typeFn: () => String }) // because UserRole is a string enum
   role: UserRole;
 }
 

diff --git a/docs-site/docs/mapping-configuration/map-with-arguments.md b/docs-site/docs/mapping-configuration/map-with-arguments.md
@@ -22,4 +22,22 @@ const dto = mapper.map(someUser, UserDto, User, {
 });
 ```
 
+## Value Resolver
+
+[Resolver](./map-from.md) can also be used with `mapWithArguments`
+
+```ts
+export const taxResolver: Resolver<Item, { percentage: number }, number> = {
+  resolve(source, { percentage }) {
+    return source.price * percentage;
+  },
+};
+
+mapper
+  .createMap(Item, ItemDto)
+  .forMember((destination) => destination.tax, mapWithArguments(taxResolver));
+
+mapper.map(item, ItemDto, Item, { extraArguments: { percentage: 0.5 } };
+```
+
 `mapWithArguments()` will set the `TransformationType` to `TransformationType.MapWithArguments`
diff --git a/docs-site/docs/migrations.md b/docs-site/docs/migrations.md
@@ -221,11 +221,11 @@ In `@automapper/core`, `ErrorHandler#handle` is default to `console.error`. `ski
 
 ```ts
 // string enum
-@AutoMap(() => String)
+@AutoMap({ typeFn: () => String })
 role: UserRole
 
 // number enum
-@AutoMap(() => Number)
+@AutoMap({ typeFn: () => Number })
 role: UserRole
 ```
 

diff --git a/docs-site/docs/plugins-system/classes-limitations.md b/docs-site/docs/plugins-system/classes-limitations.md
@@ -15,14 +15,14 @@ When designing your data models, both Domain and DTO (or View Model), you will p
 class SourceA {
   @AutoMap()
   id: number;
-  @AutoMap(() => SourceB)
+  @AutoMap({ typeFn: () => SourceB })
   sourceB: SourceB;
 }
 
 class SourceB {
   @AutoMap()
   id: number;
-  @AutoMap(() => SourceA)
+  @AutoMap({ typeFn: () => SourceA })
   sourceA: SourceA;
 }
 ```
@@ -38,7 +38,7 @@ export class Order {
   id: number;
   // ... shorten for brevity purpose
   @ManyToOne(() => Person, (person) => person.orders)
-  @AutoMap(() => Person)
+  @AutoMap({ typeFn: () => Person })
   person: Person;
 }
 
@@ -48,7 +48,7 @@ export class Person {
   id: number;
   // ... shorten for brevity purpose
   @OneToMany(() => Order, (order) => order.person)
-  @AutoMap(() => Order)
+  @AutoMap({ typeFn: () => Order })
   orders: Order[];
 }
 ```
@@ -63,14 +63,14 @@ In general, you should avoid introducing **Circular Dependency** as much as poss
 class SourceA {
   @AutoMap()
   id: number;
-  @AutoMap(() => SourceB)
+  @AutoMap({ typeFn: () => SourceB })
   sourceB: SourceB;
 }
 
 class SourceB {
   @AutoMap()
   id: number;
-  @AutoMap(() => SourceA)
+  @AutoMap({ typeFn: () => SourceA })
   sourceA: SourceA;
 }
 ```
@@ -121,14 +121,14 @@ By default, `@automapper/classes` will apply **depth of 0** to nested models. To
 class SourceA {
   @AutoMap()
   id: number;
-  @AutoMap(() => SourceB, 1)
+  @AutoMap({ typeFn: () => SourceB, depth: 1 })
   sourceB: SourceB;
 }
 
 class SourceB {
   @AutoMap()
   id: number;
-  @AutoMap(() => SourceA, 1)
+  @AutoMap({ typeFn: () => SourceA, depth: 1 })
   sourceA: SourceA;
 }
 ```
@@ -180,11 +180,11 @@ If you have `strict` mode turned on, and you have **Union Type** on your propert
 
 ```ts
 export class User {
-  @AutoMap(() => String)
+  @AutoMap({ typeFn: () => String })
   name!: string | null;
-  @AutoMap(() => Number)
+  @AutoMap({ typeFn: () => Number })
   age!: number | null;
-  @AutoMap(() => Boolean)
+  @AutoMap({ typeFn: () => Boolean })
   isAdmin!: boolean | null;
 }
 ```

diff --git a/docs-site/docs/plugins-system/classes-transformer-plugin.md b/docs-site/docs/plugins-system/classes-transformer-plugin.md
@@ -49,7 +49,7 @@ class User {
   firstName: string;
   @AutoMap()
   lastName: string;
-  @AutoMap(() => Profile)
+  @AutoMap({ typeFn: () => Profile })
   profile: Profile;
 }
 ```

diff --git a/docs-site/package.json b/docs-site/package.json
@@ -13,12 +13,12 @@
     "postinstall": "yarn build"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-alpha.71",
-    "@docusaurus/preset-classic": "2.0.0-alpha.71",
+    "@docusaurus/core": "2.0.0-alpha.72",
+    "@docusaurus/preset-classic": "2.0.0-alpha.72",
     "@mdx-js/react": "1.6.22",
     "clsx": "1.1.1",
-    "react": "17.0.1",
-    "react-dom": "17.0.1"
+    "react": "17.0.2",
+    "react-dom": "17.0.2"
   },
   "browserslist": {
     "production": [