Skip to content

Commit

Permalink
Merge pull request #78 from DDtMM/17.x
Browse files Browse the repository at this point in the history
Demo changes + storageSignal + tween refactor
  • Loading branch information
DDtMM authored Apr 19, 2024
2 parents 78675df + 850c273 commit 1afc56e
Show file tree
Hide file tree
Showing 66 changed files with 3,344 additions and 2,611 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ jobs:
steps.cache-nodemodules.outputs.cache-hit != 'true' # if cache hits the skip this step.
run: npm ci --force

- name: Add demo site source files and StackBlitz templates
run: node scripts/create-demo-file-collections.mj

- name: Build Demo site
run: npx ng build demo --base-href /angular-signal-generators/

Expand All @@ -53,6 +56,7 @@ jobs:
# - name: Update coverage on readme
# run: npx istanbul-badges-readme --coverageDir=\"./coverage/signal-generators\"


- name: Add api docs to demo site
run: npx typedoc --out dist/demo/browser/api

Expand Down
4 changes: 3 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{
"cSpell.words": [
"Easings",
"fdescribe",
"fontawesome",
"fortawesome"
"fortawesome",
"Stackblitz"
]
}
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Creates a signal whose input value is immediately mapped to a different value ba
Either a value or multiple signals can be passed and used in the selector function.

### reduceSignal

Creates a signal similar to `Array.reduce` or Rxjs's `scan` operator, using a reducer function to create a new value from the current and prior values.

### sequenceSignal
Expand All @@ -82,6 +83,10 @@ The Sequence Signal is useful for situations where you want to easily cycle betw

There is also a special option to pass a cursor, which is similar to an iterator, but can be reset. There will probably be more functionality added later.

### storageSignal / localStorageSignal / sessionStorageSignal

A signal that uses a secondary storage system to store values, ideally beyond the lifetime of the application. The next time the signal is initialized the initial value will come from this secondary storage. Implementations using *localStorage* and *sessionStorage* exist for your convenience.

### timerSignal

This is very similar to rxjs's *timer* operator. It will be have like setTimeout or interval depending on the parameters passed. The value of the timer is incremented after every "tick".
Expand Down
Loading

0 comments on commit 1afc56e

Please sign in to comment.