corvid-storeon
Advanced tools
Comparing version
{ | ||
"name": "corvid-storeon", | ||
"version": "2.4.0", | ||
"version": "2.4.1", | ||
"description": "A tiny event-based state manager Storeon for Corvid by Wix", | ||
@@ -9,16 +9,17 @@ "main": "dist/index.js", | ||
"scripts": { | ||
"lint-js": "eslint src/** dist/** tests/**", | ||
"lint-js": "eslint src/**/*.js tests/**/*.js", | ||
"lint-md": "markdownlint '**/*.md' --ignore node_modules", | ||
"dist": "rollup -c && eslint dist/** --fix", | ||
"test": "jest tests/**.test.js" | ||
"lint": "npm run lint-js && npm run lint-md", | ||
"dist": "rollup -c && eslint dist/**/*.js --fix", | ||
"test": "jest tests/*.test.js" | ||
}, | ||
"devDependencies": { | ||
"@rollup/plugin-commonjs": "^13.0.0", | ||
"@rollup/plugin-node-resolve": "^8.0.1", | ||
"eslint": "^7.2.0", | ||
"husky": "^4.2.5", | ||
"jest": "^26.0.1", | ||
"markdownlint": "^0.20.3", | ||
"markdownlint-cli": "^0.23.1", | ||
"rollup": "^2.17.1", | ||
"@rollup/plugin-commonjs": "^15.1.0", | ||
"@rollup/plugin-node-resolve": "^9.0.0", | ||
"eslint": "^7.10.0", | ||
"husky": "^4.3.0", | ||
"jest": "^26.4.2", | ||
"markdownlint": "^0.21.0", | ||
"markdownlint-cli": "^0.24.0", | ||
"rollup": "^2.28.2", | ||
"storeon": "^3.0.3" | ||
@@ -28,3 +29,3 @@ }, | ||
"hooks": { | ||
"pre-commit": "npm run lint-js && npm run lint-md && npm run dist && npm test" | ||
"pre-commit": "npm run lint && npm run dist && npm test" | ||
} | ||
@@ -31,0 +32,0 @@ }, |
@@ -26,3 +26,3 @@ # corvid-storeon | ||
```js | ||
import { createStore } from "corvid-storeon"; | ||
import { createStoreon } from "corvid-storeon"; | ||
@@ -34,3 +34,3 @@ const counter = (store) => { | ||
export const { getState, dispatch, connect, connectPage } = createStore([counter]); | ||
export const { getState, dispatch, connect, connectPage } = createStoreon([counter]); | ||
``` | ||
@@ -67,3 +67,3 @@ | ||
Latest available version: `v2.1.0` [Check status](https://www.wix.com/corvid/npm-modules) | ||
Latest available version: `v2.3.1` [Check status](https://www.wix.com/corvid/npm-modules) | ||
@@ -74,3 +74,3 @@ <img src="assets/cs.png" width="500" alt="Install corvid-storeon"> | ||
### createStore | ||
### createStoreon | ||
@@ -83,3 +83,3 @@ Creates a store that holds the complete state tree of your app | ||
```js | ||
const { getState, dispatch, connect, connectPage } = createStore(modules); | ||
const { getState, dispatch, connect, connectPage } = createStoreon(modules); | ||
``` | ||
@@ -90,3 +90,3 @@ | ||
```ts | ||
function createStore(Array<Module | false>): Store | ||
function createStoreon(Array<Module | false>): Store | ||
@@ -175,3 +175,3 @@ type Store = { | ||
The store should be created with `createStore()` function. | ||
The store should be created with `createStoreon()` function. | ||
It accepts a list of the modules. | ||
@@ -183,3 +183,3 @@ | ||
import wixWindow from "wix-window"; | ||
import { createStore } from "corvid-storeon"; | ||
import { createStoreon } from "corvid-storeon"; | ||
@@ -215,3 +215,3 @@ // Business logic | ||
export default createStore([ | ||
export default createStoreon([ | ||
appModule, | ||
@@ -225,3 +225,3 @@ (wixWindow.viewMode === "Preview" && logger), | ||
```ts | ||
function createStore(Array<Module | false>): Store | ||
function createStoreon(Array<Module | false>): Store | ||
@@ -297,3 +297,3 @@ function Module(store: StoreonStore): void | ||
It will be fired in `createStore()`. The best moment to set an initial state. | ||
It will be fired in `createStoreon()`. The best moment to set an initial state. | ||
@@ -300,0 +300,0 @@ ```js |
13842
0.4%