seangwright / typescript-functional-extensions

A TypeScript implementation of the C# library CSharpFunctionalExtensions, including synchronous and asynchronous Maybe and Result monads.
MIT License
33 stars 4 forks source link

Docs Improvement: Framework Integration #17

Open seangwright opened 1 year ago

seangwright commented 1 year ago

Is your feature request related to a problem? Please describe. It can be difficult to know which APIs of the monads in this library should be used in a given situation - specifically when using a framework that has an opinionated perspective on how to structure things and pass data around.

Describe the solution you'd like We can create small guides (linked from the README.md) that show how someone might use the library with a framework (backend and frontend) with a small snippet of example code and some principles to follow.

We could begin with a handful of framework examples, choosing the most popular as a starting point.

Here are some options:

Describe alternatives you've considered We could write blog posts to cover this but the README.md currently links out to blog posts that discuss how Maybe and Result can be used. We already have a full suite of unit tests and those should be independent of a framework anyway, so none of these improvements belong there.

Additional context See: Issue https://github.com/seangwright/typescript-functional-extensions/issues/14

xShivan commented 1 year ago

Hi. Here's a little integration we wrote in Startup Development House: https://www.npmjs.com/package/@startupdevhouse/typescript-functional-extensions-nestjs

You might want to reference it somewhere in README.md. Enjoy! 😄

seangwright commented 1 year ago

@xShivan awesome! I'll add a link in #18