doc: Add class diagram and image for failure
This commit is contained in:
parent
1f6431eec6
commit
da8bbc5c9e
@ -0,0 +1,53 @@
|
|||||||
|
@startuml Failure Class Diagram
|
||||||
|
abstract BaseFailure {
|
||||||
|
- String BASE_FAILURE_MESSAGE = "failure"
|
||||||
|
+ String message = this.BASE_FAILURE_MESSAGE
|
||||||
|
|
||||||
|
constructor(key: string)
|
||||||
|
}
|
||||||
|
|
||||||
|
class UserFailure {
|
||||||
|
constructor(key: string)
|
||||||
|
}
|
||||||
|
|
||||||
|
note left
|
||||||
|
Extends parent message key by sending
|
||||||
|
`user` keyword as a domain to parent.
|
||||||
|
So in `UserFailure` our `message`
|
||||||
|
property will be `failure.user`.
|
||||||
|
end note
|
||||||
|
|
||||||
|
UserFailure --|> BaseFailure
|
||||||
|
|
||||||
|
|
||||||
|
class UserModificationFailure {
|
||||||
|
constructor(key: string)
|
||||||
|
}
|
||||||
|
note right
|
||||||
|
Extends parent message key by sending
|
||||||
|
`modification` keyword to parent.
|
||||||
|
So in `UserModificationFailure` our `message`
|
||||||
|
property will be `failure.user.modification`
|
||||||
|
end note
|
||||||
|
UserModificationFailure --|> UserFailure
|
||||||
|
|
||||||
|
class UserModificationAlreadyExistsFailure {
|
||||||
|
constructor()
|
||||||
|
}
|
||||||
|
note left
|
||||||
|
Extends parent message key by sending
|
||||||
|
`alreadyExists` keyword to parent.
|
||||||
|
So in `UserModificationAlreadyExistsFailure`
|
||||||
|
our `message` property will be
|
||||||
|
`failure.user.modification.AlreadyExists`
|
||||||
|
end note
|
||||||
|
|
||||||
|
class DeviceFailure {
|
||||||
|
constructor()
|
||||||
|
}
|
||||||
|
|
||||||
|
DeviceFailure --|> BaseFailure
|
||||||
|
UserModificationAlreadyExistsFailure --|> UserModificationFailure
|
||||||
|
|
||||||
|
|
||||||
|
@enduml
|
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 14 KiB |
@ -212,4 +212,6 @@ if (!isLeft(usecaseResponse)) return;
|
|||||||
if (!(usecaseResponse instanceOf BaseFailure)) return;
|
if (!(usecaseResponse instanceOf BaseFailure)) return;
|
||||||
|
|
||||||
const translatedFailureMessage = t(usecaseResponse.left.message)
|
const translatedFailureMessage = t(usecaseResponse.left.message)
|
||||||
```
|
```
|
||||||
|
This is the final version, class diagram for our failur architecture:
|
||||||
|

|
Loading…
x
Reference in New Issue
Block a user