typescript-functional-extensions icon indicating copy to clipboard operation
typescript-functional-extensions copied to clipboard

Published 20 hours ago • verified publisher icon seangwright

Docs Improvement: Framework Integration

Open seangwright opened this issue 2 years ago • 2 comments

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:

  • Backend

    • Nestjs
    • Fastify
    • Nextjs
    • Remix

  • Frontend

    • Svelte
    • Vue
    • Angular
    • React
    • AlpineJS
    • Vanilla JS

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

seangwright avatar Sep 29 '22 00:09 seangwright