navigation-stack 0.1.0 → 0.1.2

package/.github/workflows/main.yml

@@ -1,39 +1,39 @@
-name: Build and test
-on:
-  push:
-    branches: [master]
-  pull_request:
-    branches: [master]
-
-env:
-  DISPLAY: :99.0
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        browser: ['ChromeCi', 'Firefox']
-        node-version: [16.x]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup firefox
-        if: ${{ matrix.browser == 'Firefox' }}
-        uses: browser-actions/setup-firefox@latest
-        with:
-          firefox-version: 'latest'
-      - name: Setup xvfb
-        run: |
-          sudo apt-get install xvfb
-          Xvfb $DISPLAY -screen 0 1024x768x24 > /dev/null 2>&1 &
-      - run: yarn install --frozen-lockfile
-      - env:
-          BROWSER: ${{ matrix.browser }}
-        run: yarn test --coverage
-      - run: node_modules/.bin/codecov
+name: Build and test
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+env:
+  DISPLAY: :99.0
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        browser: ['ChromeCi', 'Firefox']
+        node-version: [16.x]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup firefox
+        if: ${{ matrix.browser == 'Firefox' }}
+        uses: browser-actions/setup-firefox@latest
+        with:
+          firefox-version: 'latest'
+      - name: Setup xvfb
+        run: |
+          sudo apt-get install xvfb
+          Xvfb $DISPLAY -screen 0 1024x768x24 > /dev/null 2>&1 &
+      - run: yarn install --frozen-lockfile
+      - env:
+          BROWSER: ${{ matrix.browser }}
+        run: yarn test --coverage
+      - run: node_modules/.bin/codecov

package/README.md

@@ -1,27 +1,9 @@
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
-
-- [navigation-stack](#navigation-stack)
-  - [Install](#install)
-  - [Use](#use)
-  - [Current Location](#current-location)
-  - [Why Redux?](#why-redux)
-  - [Environment](#environment)
-  - [Base Path](#base-path)
-  - [Location State Storage](#location-state-storage)
-  - [Block Navigation](#block-navigation)
-  - [Utility](#utility)
-  - [Development](#development)
-
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
-
 # navigation-stack
 
 [![npm version](https://img.shields.io/npm/v/navigation-stack.svg?style=flat-square)](https://www.npmjs.com/package/navigation-stack)
 [![npm downloads](https://img.shields.io/npm/dm/navigation-stack.svg?style=flat-square)](https://www.npmjs.com/package/navigation-stack)
 
-Handles web browser navigation in a web application.
+Handles navigation in a web browser. Represents web browser navigation history as a "stack" data structure. Provides operations to perform programmatic navigation such as "push" (go to new URL), "replace" (redirect to new URL), "shift" (rewind to a previously visited URL). Provides a subscription mechanism to get notified on current location change.
 
 Originally forked from [`farce`](http://npmjs.com/package/farce) package to fix a [bug](https://github.com/4Catalyzer/farce/issues/483).
 
@@ -102,9 +84,11 @@ function reducer(state, action) {
 }
 ```
 
-Calling `store.dispatch(Actions.init())` will trigger the initial `ActionTypes.UPDATE` action which will set the current location. From then on, the current location will always stay in sync with the web browser's URL bar.
+With this reducer, `store.getState()` will return the current location.
+
+Calling `store.dispatch(Actions.init())` will trigger the initial `ActionTypes.UPDATE` action which will set the initial current location. From then on, the current location will always stay in sync with the web browser's URL bar, including "Back"/"Forward" navigation.
 
-The current location will also "magically" be updated when the user clicks "Back" or "Forward" button in the web browser.
+One could use Redux'es standard [subscription mechanisms](https://redux.js.org/api/store#subscribelistener) to immediately get notified of current location changes.
 
 ## Why Redux?
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "navigation-stack",
-  "version": "0.1.0",
-  "description": "Handles web browser navigation in a web application",
+  "version": "0.1.2",
+  "description": "Handles navigation in a web browser",
   "keywords": [
     "history",
     "browser",
@@ -40,8 +40,7 @@
     }
   },
   "lint-staged": {
-    "*": "yarn 4c lint --fix --prettier-ignore .eslintignore",
-    "README.md": "doctoc"
+    "*": "yarn 4c lint --fix --prettier-ignore .eslintignore"
   },
   "prettier": "@4c/prettier-config",
   "dependencies": {

package/types/index.d.ts

@@ -184,7 +184,7 @@ export const Actions: {
   init(): InitAction;
   push(location: InputLocation): PushAction;
   replace(location: InputLocation): ReplaceAction;
-  go(delta: number): RewindAction;
+  shift(delta: number): RewindAction;
   dispose(): DisposeAction;
 };
 
@@ -199,7 +199,7 @@ export interface Environment {
 
   navigate(location: LocationBase): Location;
 
-  go(delta: number): void;
+  shift(delta: number): void;
 
   addBeforeDestroyListener(listener: BeforeDestroyListener): void;
 
@@ -218,7 +218,7 @@ declare abstract class EnvironmentBase implements Environment {
 
   navigate(location: LocationBase): Location;
 
-  go(delta: number): void;
+  shift(delta: number): void;
 
   addBeforeDestroyListener(listener: BeforeDestroyListener): void;