@cycle/history - npm Package Compare versions

Comparing version 7.4.0 to 8.0.0

CHANGELOG.md

@@ -0,1 +1,12 @@
+## 8.0.0 (2021-02-17)
+
+* feat(history): complete support for history.replace API ([268949e](https://github.com/cyclejs/cyclejs/commit/268949e))
+
+
+### BREAKING CHANGE
+
+* 🧨 The search/hash has to be provided as separate fields and can no longer
+be included in the pathname.
+
+
 ## 7.4.0 (2019-11-06)
@@ -2,0 +13,0 @@

lib/cjs/createHistory$.js

@@ -35,3 +35,3 @@ "use strict";
         if (input.type === 'replace') {
-            history.replace(input.pathname, input.state);
+            history.replace(__assign({}, input));
         }
@@ -38,0 +38,0 @@ if (input.type === 'go') {

lib/cjs/types.d.ts

@@ -20,3 +20,6 @@ import { Stream, MemoryStream } from 'xstream';
     pathname: Pathname;
+    search?: Search;
     state?: any;
+    hash?: Hash;
+    key?: LocationKey;
 };
@@ -23,0 +26,0 @@ export declare type GoHistoryInput = {

lib/es6/createHistory$.js

@@ -32,3 +32,3 @@ var __assign = (this && this.__assign) || function () {
         if (input.type === 'replace') {
-            history.replace(input.pathname, input.state);
+            history.replace(__assign({}, input));
         }
@@ -35,0 +35,0 @@ if (input.type === 'go') {

lib/es6/types.d.ts

@@ -20,3 +20,6 @@ import { Stream, MemoryStream } from 'xstream';
     pathname: Pathname;
+    search?: Search;
     state?: any;
+    hash?: Hash;
+    key?: LocationKey;
 };
@@ -23,0 +26,0 @@ export declare type GoHistoryInput = {

package.json

 {
-	"name": "@cycle/history",
-	"version": "7.4.0",
-	"description": "The standard history driver for Cycle.js",
-	"main": "lib/cjs/index.js",
-	"module": "lib/es6/index.js",
-	"typings": "lib/cjs/index.d.ts",
-	"types": "lib/cjs/index.d.ts",
-	"directories": {
-		"test": "test"
-	},
-	"repository": "https://github.com/cyclejs/cyclejs/tree/master/history",
-	"author": "Tylor Steinberger",
-	"license": "MIT",
-	"bugs": "https://github.com/cyclejs/cyclejs/issues",
-	"homepage": "https://cycle.js.org",
-	"dependencies": {
-		"@cycle/run": "^5.2.0",
-		"@types/history": "^4.7.2",
-		"history": "4.7.x",
-		"xstream": "*"
-	},
-	"devDependencies": {
-		"@cycle/rxjs-run": "^10.2.0",
-		"@types/mocha": "~5.2.7",
-		"@types/node": "^10.12.11",
-		"@types/sinon": "^5.0.7",
-		"deepmerge": "~4.0.0",
-		"karma": "~4.2.0",
-		"karma-browserstack-launcher": "~1.5.1",
-		"karma-chrome-launcher": "~3.0.0",
-		"karma-firefox-launcher": "~1.1.0",
-		"karma-mocha": "~1.3.0",
-		"karma-typescript": "~4.1.1",
-		"mocha": "~6.2.0",
-		"rxjs": "6.3.x",
-		"sinon": "^7.1.1",
-		"ts-node": "^7.0.1",
-		"tslint": "^5.11.0",
-		"typescript": "=3.2.4",
-		"xstream": "11.x"
-	},
-	"funding": {
-		"type": "opencollective",
-		"url": "https://opencollective.com/cyclejs"
-	},
-	"scripts": {
-		"build": "pnpm run build-cjs && pnpm run build-es6",
-		"build-cjs": "tsc --module commonjs --outDir ./lib/cjs",
-		"build-es6": "tsc --module es6 --outDir ./lib/es6",
-		"lint": "tslint --project tsconfig.lint.json --config ../tslint.json",
-		"docs": "cd .. && node .scripts/make-api-docs.js history",
-		"changelog": "cd .. && node .scripts/update-changelogs.js history",
-		"test-node": "mocha --require ts-node/register test/node/*.ts --exit",
-		"test-browser": "karma start",
-		"test": "pnpm run test-node && pnpm run test-browser",
-		"test-ci": "CI=true ../.scripts/retry.sh pnpm test",
-		"test-live": "LIVE=true pnpm test",
-		"prepublishOnly": "pnpm run build && pnpm test"
-	}
+  "name": "@cycle/history",
+  "version": "8.0.0",
+  "description": "The standard history driver for Cycle.js",
+  "main": "lib/cjs/index.js",
+  "module": "lib/es6/index.js",
+  "typings": "lib/cjs/index.d.ts",
+  "types": "lib/cjs/index.d.ts",
+  "directories": {
+    "test": "test"
+  },
+  "repository": "https://github.com/cyclejs/cyclejs/tree/master/history",
+  "author": "Tylor Steinberger",
+  "license": "MIT",
+  "bugs": "https://github.com/cyclejs/cyclejs/issues",
+  "homepage": "https://cycle.js.org",
+  "dependencies": {
+    "@cycle/run": "^5.2.0",
+    "@types/history": "^4.7.2",
+    "history": "4.7.x",
+    "xstream": "*"
+  },
+  "devDependencies": {
+    "@cycle/rxjs-run": "^10.2.0",
+    "@types/mocha": "~5.2.7",
+    "@types/node": "^10.12.11",
+    "@types/sinon": "^5.0.7",
+    "deepmerge": "~4.0.0",
+    "karma": "~4.2.0",
+    "karma-browserstack-launcher": "~1.5.1",
+    "karma-chrome-launcher": "~3.0.0",
+    "karma-firefox-launcher": "~1.1.0",
+    "karma-mocha": "~1.3.0",
+    "karma-typescript": "~4.1.1",
+    "mocha": "~6.2.0",
+    "rxjs": "6.3.x",
+    "sinon": "^7.1.1",
+    "ts-node": "^7.0.1",
+    "tslint": "^5.11.0",
+    "typescript": "=3.2.4",
+    "xstream": "11.x"
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/cyclejs"
+  },
+  "scripts": {
+    "build": "pnpm run build-cjs && pnpm run build-es6",
+    "build-cjs": "tsc --module commonjs --outDir ./lib/cjs",
+    "build-es6": "tsc --module es6 --outDir ./lib/es6",
+    "lint": "tslint --project tsconfig.lint.json --config ../tslint.json",
+    "docs": "cd .. && node .scripts/make-api-docs.js history",
+    "changelog": "cd .. && node .scripts/update-changelogs.js history",
+    "test-node": "mocha --require ts-node/register test/node/*.ts --exit",
+    "test-browser": "karma start",
+    "test": "pnpm run test-node && pnpm run test-browser",
+    "test-ci": "CI=true ../.scripts/retry.sh pnpm test",
+    "test-live": "LIVE=true pnpm test",
+    "prepublishOnly": "pnpm run build && pnpm test"
+  }
 }

src/createHistory$.ts

@@ -31,3 +31,3 @@ import xs, {Stream, MemoryStream, Listener} from 'xstream';
     if (input.type === 'replace') {
-      history.replace(input.pathname, input.state);
+      history.replace({...input});
     }
@@ -34,0 +34,0 @@

src/types.ts

@@ -26,3 +26,6 @@ import {Stream, MemoryStream} from 'xstream';
   pathname: Pathname;
+  search?: Search;
   state?: any;
+  hash?: Hash;
+  key?: LocationKey;
 };
@@ -29,0 +32,0 @@

No alert changes

Improved metrics

Total package byte prevSize

88619

increased by0.52%

Lines of code

2058

increased by0.44%

No dependency changes