Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve typings and README #71

Merged
merged 2 commits into from
Aug 5, 2024
Merged

Improve typings and README #71

merged 2 commits into from
Aug 5, 2024

Conversation

pipex
Copy link
Collaborator

@pipex pipex commented Aug 5, 2024

Adds some improvements to the types on task constructors to enforce the context is treated as read-only by the effect and action functions. This ensures tasks can only modify the state referenced by their lens.

This also fixes some errors on the README

Change-type: minor

Change-type: patch
This enforces that the context in the functions defined when
constructing a task are treated as Read-Only objects. This prevents a
task from modifying part of the state outside what is referenced by its
defined lens path.

Change-type: minor
@pipex
Copy link
Collaborator Author

pipex commented Aug 5, 2024

I self-certify!

@flowzone-app flowzone-app bot merged commit e03e1e1 into main Aug 5, 2024
51 checks passed
@flowzone-app flowzone-app bot deleted the readme-fixes branch August 5, 2024 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant