Skip to content

Commit

Permalink
remove newlines
Browse files Browse the repository at this point in the history
  • Loading branch information
btrautmann committed May 10, 2023
1 parent 85c693f commit 87af8d5
Showing 1 changed file with 0 additions and 3 deletions.
3 changes: 0 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ A strongly typed, event-based, reliable HTTP client that wraps `Dio`.
- Clear enumeration of response types (see `NetworkResponse`)

> **Note**
> At Betterment, we've used `SturdyHttp` internally for the past year. It's been battle-tested across over 200 network request call sites throughout the application and its opinionated nature is a direct result of this experimentation. We're always open to making it more flexible if it makes sense to do so; feel free to drop an Issue to discuss doing so!
## Usage
Expand Down Expand Up @@ -46,7 +45,6 @@ Future<Result<MyData>> fetch({required int id}) async {
}
```
> **Note**
> Because `Result` types are _very_ opinionated, `SturdyHttp` does not return a `Result` but rather the generic type provided to `execute` (and returned by `onResponse`). If this type fails to be
deserialized, an `Exception` will be thrown. This can be managed by adding an extension on top of the client itself, which is how we interact with the client ourselves. For example:

Expand All @@ -72,7 +70,6 @@ extension SturdyHttpX on SturdyHttp {
```

> **Warning**
> We're considering open-sourcing our `Result` type and integrating it into `SturdyHttp`. If we did, we'd likely change `execute`'s return type to be a `Result`, and offer `executeUnsafe` as the non-`Result` (i.e `Exception` throwing) alternative. This would be a breaking change.
## Contributing
Expand Down

0 comments on commit 87af8d5

Please sign in to comment.