Skip to content

Commit

Permalink
docs: add documentation on self mapping
Browse files Browse the repository at this point in the history
  • Loading branch information
nartc committed Jul 1, 2022
1 parent f06bf24 commit 3a3b84d
Show file tree
Hide file tree
Showing 42 changed files with 515 additions and 229 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Depth for nested models. Default to 1

#### Defined in

[lib/automap.ts:13](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/automap.ts#L13)
[lib/automap.ts:13](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/automap.ts#L13)

___

Expand All @@ -28,7 +28,7 @@ Is this property getter-only?

#### Defined in

[lib/automap.ts:17](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/automap.ts#L17)
[lib/automap.ts:17](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/automap.ts#L17)

## Methods

Expand All @@ -44,4 +44,4 @@ Type Function

#### Defined in

[lib/automap.ts:9](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/automap.ts#L9)
[lib/automap.ts:9](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/automap.ts#L9)
16 changes: 8 additions & 8 deletions packages/documentations/docs/api/classes/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ custom_edit_url: null

#### Defined in

[lib/keys.ts:1](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/keys.ts#L1)
[lib/keys.ts:1](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/keys.ts#L1)

___

Expand All @@ -28,7 +28,7 @@ ___

#### Defined in

[lib/keys.ts:3](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/keys.ts#L3)
[lib/keys.ts:3](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/keys.ts#L3)

___

Expand All @@ -38,7 +38,7 @@ ___

#### Defined in

[lib/keys.ts:4](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/keys.ts#L4)
[lib/keys.ts:4](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/keys.ts#L4)

## Functions

Expand All @@ -52,7 +52,7 @@ ___

#### Defined in

[lib/automap.ts:20](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/automap.ts#L20)
[lib/automap.ts:20](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/automap.ts#L20)

**AutoMap**(`typeFn`): `PropertyDecorator`

Expand All @@ -68,7 +68,7 @@ ___

#### Defined in

[lib/automap.ts:21](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/automap.ts#L21)
[lib/automap.ts:21](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/automap.ts#L21)

**AutoMap**(`options`): `PropertyDecorator`

Expand All @@ -84,7 +84,7 @@ ___

#### Defined in

[lib/automap.ts:24](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/automap.ts#L24)
[lib/automap.ts:24](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/automap.ts#L24)

___

Expand All @@ -104,7 +104,7 @@ ___

#### Defined in

[lib/classes.ts:14](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/classes.ts#L14)
[lib/classes.ts:14](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/classes.ts#L14)

___

Expand All @@ -124,4 +124,4 @@ ___

#### Defined in

[lib/get-metadata-list.ts:20](https://github.com/nartc/mapper/blob/a29e3690/packages/classes/src/lib/get-metadata-list.ts#L20)
[lib/get-metadata-list.ts:20](https://github.com/nartc/mapper/blob/f06bf24a/packages/classes/src/lib/get-metadata-list.ts#L20)
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ CamelCaseNamingConvention

#### Defined in

[lib/naming-conventions/camel-case-naming-convention.ts:9](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/camel-case-naming-convention.ts#L9)
[lib/naming-conventions/camel-case-naming-convention.ts:9](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/camel-case-naming-convention.ts#L9)

___

Expand All @@ -46,7 +46,7 @@ ___

#### Defined in

[lib/naming-conventions/camel-case-naming-convention.ts:10](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/camel-case-naming-convention.ts#L10)
[lib/naming-conventions/camel-case-naming-convention.ts:10](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/camel-case-naming-convention.ts#L10)

## Methods

Expand All @@ -70,4 +70,4 @@ ___

#### Defined in

[lib/naming-conventions/camel-case-naming-convention.ts:12](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/camel-case-naming-convention.ts#L12)
[lib/naming-conventions/camel-case-naming-convention.ts:12](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/camel-case-naming-convention.ts#L12)
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ PascalCaseNamingConvention

#### Defined in

[lib/naming-conventions/pascal-case-naming-convention.ts:9](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/pascal-case-naming-convention.ts#L9)
[lib/naming-conventions/pascal-case-naming-convention.ts:9](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/pascal-case-naming-convention.ts#L9)

___

Expand All @@ -46,7 +46,7 @@ ___

#### Defined in

[lib/naming-conventions/pascal-case-naming-convention.ts:10](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/pascal-case-naming-convention.ts#L10)
[lib/naming-conventions/pascal-case-naming-convention.ts:10](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/pascal-case-naming-convention.ts#L10)

## Methods

Expand All @@ -70,4 +70,4 @@ ___

#### Defined in

[lib/naming-conventions/pascal-case-naming-convention.ts:12](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/pascal-case-naming-convention.ts#L12)
[lib/naming-conventions/pascal-case-naming-convention.ts:12](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/pascal-case-naming-convention.ts#L12)
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ SnakeCaseNamingConvention

#### Defined in

[lib/naming-conventions/snake-case-naming-convention.ts:9](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/snake-case-naming-convention.ts#L9)
[lib/naming-conventions/snake-case-naming-convention.ts:9](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/snake-case-naming-convention.ts#L9)

___

Expand All @@ -46,7 +46,7 @@ ___

#### Defined in

[lib/naming-conventions/snake-case-naming-convention.ts:10](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/snake-case-naming-convention.ts#L10)
[lib/naming-conventions/snake-case-naming-convention.ts:10](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/snake-case-naming-convention.ts#L10)

## Methods

Expand All @@ -70,4 +70,4 @@ ___

#### Defined in

[lib/naming-conventions/snake-case-naming-convention.ts:12](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/naming-conventions/snake-case-naming-convention.ts#L12)
[lib/naming-conventions/snake-case-naming-convention.ts:12](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/naming-conventions/snake-case-naming-convention.ts#L12)
6 changes: 3 additions & 3 deletions packages/documentations/docs/api/core/enums/MapFnClassId.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:268](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L268)
[lib/types.ts:312](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L312)

___

Expand All @@ -24,7 +24,7 @@ ___

#### Defined in

[lib/types.ts:269](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L269)
[lib/types.ts:313](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L313)

___

Expand All @@ -34,4 +34,4 @@ ___

#### Defined in

[lib/types.ts:267](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L267)
[lib/types.ts:311](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L311)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:445](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L445)
[lib/types.ts:489](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L489)

___

Expand All @@ -24,4 +24,4 @@ ___

#### Defined in

[lib/types.ts:444](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L444)
[lib/types.ts:488](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L488)
16 changes: 8 additions & 8 deletions packages/documentations/docs/api/core/enums/MappingClassId.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:465](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L465)
[lib/types.ts:509](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L509)

___

Expand All @@ -24,7 +24,7 @@ ___

#### Defined in

[lib/types.ts:463](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L463)
[lib/types.ts:507](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L507)

___

Expand All @@ -34,7 +34,7 @@ ___

#### Defined in

[lib/types.ts:460](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L460)
[lib/types.ts:504](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L504)

___

Expand All @@ -44,7 +44,7 @@ ___

#### Defined in

[lib/types.ts:459](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L459)
[lib/types.ts:503](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L503)

___

Expand All @@ -54,7 +54,7 @@ ___

#### Defined in

[lib/types.ts:462](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L462)
[lib/types.ts:506](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L506)

___

Expand All @@ -64,7 +64,7 @@ ___

#### Defined in

[lib/types.ts:466](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L466)
[lib/types.ts:510](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L510)

___

Expand All @@ -74,7 +74,7 @@ ___

#### Defined in

[lib/types.ts:461](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L461)
[lib/types.ts:505](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L505)

___

Expand All @@ -84,4 +84,4 @@ ___

#### Defined in

[lib/types.ts:464](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L464)
[lib/types.ts:508](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L508)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:439](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L439)
[lib/types.ts:483](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L483)

___

Expand All @@ -24,7 +24,7 @@ ___

#### Defined in

[lib/types.ts:440](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L440)
[lib/types.ts:484](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L484)

___

Expand All @@ -34,4 +34,4 @@ ___

#### Defined in

[lib/types.ts:438](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L438)
[lib/types.ts:482](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L482)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:422](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L422)
[lib/types.ts:466](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L466)

___

Expand All @@ -24,4 +24,4 @@ ___

#### Defined in

[lib/types.ts:423](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L423)
[lib/types.ts:467](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L467)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:408](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L408)
[lib/types.ts:452](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L452)

___

Expand All @@ -24,4 +24,4 @@ ___

#### Defined in

[lib/types.ts:409](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L409)
[lib/types.ts:453](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L453)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:137](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L137)
[lib/types.ts:137](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L137)

___

Expand All @@ -24,7 +24,7 @@ ___

#### Defined in

[lib/types.ts:138](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L138)
[lib/types.ts:138](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L138)

___

Expand All @@ -34,7 +34,7 @@ ___

#### Defined in

[lib/types.ts:136](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L136)
[lib/types.ts:136](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L136)

___

Expand All @@ -44,4 +44,4 @@ ___

#### Defined in

[lib/types.ts:135](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L135)
[lib/types.ts:135](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L135)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:131](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L131)
[lib/types.ts:131](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L131)

___

Expand All @@ -24,4 +24,4 @@ ___

#### Defined in

[lib/types.ts:130](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L130)
[lib/types.ts:130](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L130)
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ custom_edit_url: null

#### Defined in

[lib/types.ts:449](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L449)
[lib/types.ts:493](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L493)

___

Expand All @@ -24,4 +24,4 @@ ___

#### Defined in

[lib/types.ts:450](https://github.com/nartc/mapper/blob/a29e3690/packages/core/src/lib/types.ts#L450)
[lib/types.ts:494](https://github.com/nartc/mapper/blob/f06bf24a/packages/core/src/lib/types.ts#L494)
Loading

0 comments on commit 3a3b84d

Please sign in to comment.