Compare commits

..

3 Commits

Author SHA1 Message Date
55376db1c2 packages go in the release dir 2024-08-08 09:40:28 -04:00
33a10d6916 packing cleaning 2024-08-08 09:37:38 -04:00
dd7b7159b1 set the alpha version 2024-08-08 09:29:57 -04:00
7 changed files with 17 additions and 72 deletions

1
.gitignore vendored
View File

@ -13,3 +13,4 @@ pnpm-lock.yaml
updux-5.0.0.tgz updux-5.0.0.tgz
.envrc .envrc
.task .task
releases

View File

@ -26,3 +26,8 @@ updux-*.tgz
vitest.config.js vitest.config.js
yarn-error.log yarn-error.log
yarn.lock yarn.lock
docs*
.envrc
contrib/*
typedoc.json
dist/tutorial/*

View File

@ -6,11 +6,21 @@ vars:
PARENT_BRANCH: main PARENT_BRANCH: main
tasks: tasks:
pack:
cmds:
- npm pack --pack-destination releases
build: tsc build: tsc
checks: checks:
deps: [test, build] deps: [test, build]
prepare:
desc: build and bundle the package
cmds:
- { task: build }
- { task: pack }
integrate: integrate:
deps: [checks] deps: [checks]
cmds: cmds:

View File

@ -1,8 +0,0 @@
import { redirect } from '@sveltejs/kit';
export const prerender = true;
/** @type {import('./$types').PageLoad} */
export function load() {
throw redirect(307, '/docs/first-category/first-page');
}

View File

@ -1,47 +0,0 @@
---
title: Introduction
---
Updux is a class that collects together all the stuff pertaining to a Redux
reducer -- actions, middleware, subscriptions, selectors -- in a way that
is as modular and as TypeScript-friendly as possible.
While it has originally been created to play well with [updeep][], it also
work wells with plain JavaScript, and
interfaces very neatly with other immutability/deep merging libraries
like
[Mutative], [immer][], [updeep][],
[remeda][],
[lodash][], etc.
## Updux terminology
<dl>
<dt>Updux</dt>
<dd>Object encapsulating the information pertinent for a Redux reducer.
Named thus because it has been designed to work well with [updeep][],
and follows my spin on
the [Ducks pattern](https://github.com/erikras/ducks-modular-redux).</dd>
<dt>Mutation</dt>
<dd>Reducing function, mostly associated with an action. All mutations of
an updux object are combined to form its reducer.</dd>
<dt>Subdux</dt>
<dd>Updux objects associated with sub-states of a main updux. The main
updux will inherit all of its subduxes actions, mutations, reactions,
etc.</dd>
<dt>Effect</dt>
<dd>A Redux middleware, augmented with a few goodies.</dd>
<dt>Reaction</dt>
<dd>Subscription to a updux. Unlike regular Redux subscriptions, don't
trigger if the state of the updux isn't changed by the reducing.</dd>
</dl>
[updeep]: https://www.npmjs.com/package/@yanick/updeep-remeda
[immer]: https://www.npmjs.com/package/immer
[lodash]: https://www.npmjs.com/package/lodash
[ts-action]: https://www.npmjs.com/package/ts-action
[remeda]: remedajs.com/
[Mutative]: https://mutative.js.org/

View File

@ -1,16 +0,0 @@
site_name: Updux
theme:
name: material
markdown_extensions:
- pymdownx.snippets
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.highlight:
default_lang: js
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
nav:
- Home: index.md
- Tutorial: tutorial.md
- API: api/modules.md

View File

@ -27,7 +27,7 @@
"scripts": { "scripts": {
"docsify:serve": "docsify serve docs" "docsify:serve": "docsify serve docs"
}, },
"version": "5.1.0", "version": "4.0.0-alpha.1",
"repository": { "repository": {
"type": "git", "type": "git",
"url": "git+https://github.com/yanick/updux.git" "url": "git+https://github.com/yanick/updux.git"