docs(website): fix operators api docs

Author: christianalfoni

packages/node_modules/overmind-devtools/src/overmind/operators.ts

@@ -209,7 +209,7 @@ export const addAction: () => Operator<StartActionMessage> = () =>
       const existingId = (app.actionsList[0] as ActionItem).id
       app.actionsList[0] = {
         type: ActionsListItemType.GROUP,
-        id: getActionId(action),
+        id: actionId,
         actionId: action.actionId,
         isCollapsed: true,
         actionIds: [actionId, existingId],

packages/overmind-website/api/operators.md

@@ -69,6 +69,15 @@ You use this operator whenever you want to change the state of the app, but you
 h(Example, { name: "api/operators_operator_action" })
 ```
 
+## noop
+
+This operator does absolutely nothing. Is useful when paths of execution is not supposed to do anything.
+
+```marksy
+h(Example, { name: "api/operators_operator_noop" })
+```
+
+
 ## parallel
 Will run every operator and wait for all of them to finish before moving on. Works like *Promise.all*.
 
@@ -83,6 +92,14 @@ The pipe is an operator in itself. Use it to compose other operators and pipes.
 h(Example, { name: "api/operators_operator_pipe" })
 ```
 
+## run
+
+This operator allows you to run side effects. You can not change state and you can not return a value.
+
+```marksy
+h(Example, { name: "api/operators_operator_run" })
+```
+
 ## tryCatch
 This operator allows you to scope execution and manage errors. This operator does not return a new value to the execution.
 

packages/overmind-website/examples/api/onInitialize.ts

@@ -9,11 +9,10 @@ export default (ts, view) =>
 import { OnInitialize } from 'overmind'
 
 const onInitialize: OnInitialize = async ({
-  value: overmind,
   state,
   actions,
   effects
-}) => {
+}, overmind) => {
   const initialData = await effects.api.getInitialData()
   state.initialData = initialData
 }
@@ -44,11 +43,10 @@ const config = {
           fileName: 'overmind/onInitialize.js',
           code: `
 const onInitialize = async ({
-  value: overmind,
   state,
   actions,
   effects
-}) => {
+}, overmind) => {
   const initialData = await effects.api.getInitialData()
   state.initialData = initialData
 }

packages/overmind-website/examples/api/operators.ts

@@ -5,9 +5,10 @@ export default (ts) =>
           code: `
 import { Operator, mutate } from 'overmind'
 
-export const changeFoo: Operator = mutate(({ state }) => {
-  state.foo = 'bar'
-})
+export const changeFoo: <T>() => Operator<T> = () =>
+  mutate(({ state }) => {
+    state.foo = 'bar'
+  })
 `,
         },
       ]
@@ -16,9 +17,10 @@ export const changeFoo: Operator = mutate(({ state }) => {
           code: `
 import { mutate } from 'overmind'
 
-export const changeFoo = mutate(({ state }) => {
-  state.foo = 'bar'
-})
+export const changeFoo = () => 
+  mutate(({ state }) => {
+    state.foo = 'bar'
+  })
 `,
         },
       ]

packages/overmind-website/examples/api/operators_operator_action.ts

@@ -2,23 +2,27 @@ export default (ts) =>
   ts
     ? [
         {
+          fileName: 'operators.ts',
           code: `
 import { Operator, mutate } from 'overmind'
 
-export const setUser: Operator<User> = mutate(({ value: user, state }) => {
-  state.user = user
-})
+export const setUser: () => Operator<User> = () =>
+  mutate(function setUser({ state }, user) {
+    state.user = user
+  })
 `,
         },
       ]
     : [
         {
+          fileName: 'operators.js',
           code: `
 import { mutate } from 'overmind'
 
-export const setUser = mutate(({ value: user, state }) => {
-  state.user = user
-})
+export const setUser = () =>
+  mutate(function setUser({ state }, user) {
+    state.user = user
+  })
 `,
         },
       ]

packages/overmind-website/examples/api/operators_operator_catcherror.ts

@@ -2,6 +2,7 @@ export default (ts) =>
   ts
     ? [
         {
+          fileName: 'actions.ts',
           code: `
 import { Operator, pipe, mutate, catchError } from 'overmind'
 
@@ -26,6 +27,7 @@ export const doSomething: Operator<string> = pipe(
       ]
     : [
         {
+          fileName: 'actions.js',
           code: `
 import { pipe, mutate, catchError } from 'overmind'
 

packages/overmind-website/examples/api/operators_operator_debounce.ts

@@ -2,26 +2,28 @@ export default (ts) =>
   ts
     ? [
         {
+          fileName: 'actions.ts',
           code: `
 import { Operator, pipe, debounce } from 'overmind'
-import { performSearch } from './operators'
+import * as o from './operators'
 
 export const search: Operator<string> = pipe(
   debounce(200),
-  performSearch
+  o.performSearch()
 )
 `,
         },
       ]
     : [
         {
+          fileName: 'actions.js',
           code: `
 import { pipe, debounce } from 'overmind'
-import { performSearch } from './operators'
+import * as o from './operators'
 
 export const search = pipe(
   debounce(200),
-  performSearch
+  o.performSearch()
 )
 `,
         },

packages/overmind-website/examples/api/operators_operator_filter.ts

@@ -2,21 +2,27 @@ export default (ts) =>
   ts
     ? [
         {
+          fileName: 'operators.ts',
           code: `
 import { Operator, filter } from 'overmind'
 
-export const lengthGreaterThan: (length: number) => Operator<string> =
-  (length) => filter(({ value }) => value.length > length)
+export const lengthGreaterThan: (length: number) => Operator<string> = (length) =>
+  filter(function lengthGreaterThan(_, value) {
+    return value.length > length
+  })
 `,
         },
       ]
     : [
         {
+          fileName: 'operators.js',
           code: `
 import { filter } from 'overmind'
 
 export const lengthGreaterThan = (length) =>
-  filter(({ value }) => value.length > length)
+  filter(function lengthGreaterThan(_, value) {
+    return value.length > length
+  })
 `,
         },
       ]

packages/overmind-website/examples/api/operators_operator_forEach.ts

@@ -2,27 +2,29 @@ export default (ts) =>
   ts
     ? [
         {
+          fileName: 'actions.ts',
           code: `
 import { Operator, pipe, forEach } from 'overmind'
 import { Post } from './state'
-import { getPosts, getAuthor } from './operators'
+import * as o from './operators'
 
 export const openPosts: Operator<string, Post[]> = pipe(
-  getPosts,
-  forEach(getAuthor)
+  o.getPosts(),
+  forEach(o.getAuthor())
 )
 `,
         },
       ]
     : [
         {
+          fileName: 'actions.js',
           code: `
 import { pipe, forEach } from 'overmind'
-import { getPosts, getAuthor } from './operators'
+import * as o from './operators'
 
 export const openPosts = pipe(
-  getPosts,
-  forEach(getAuthor)
+  o.getPosts(),
+  forEach(o.getAuthor())
 )
 `,
         },

packages/overmind-website/examples/api/operators_operator_fork.ts

@@ -2,51 +2,56 @@ export default (ts) =>
   ts
     ? [
         {
-          fileName: 'overmind/operators.ts',
+          fileName: 'operators.ts',
           code: `
 import { fork, Operator } from 'overmind'
 import { User } from './state'
 
-export const forkUserType: (paths: { [key: string]: Operator<User> }) => Operator<User> =
-  (paths) => fork(({ value: user }) => user.type, paths)
+export const forkUserType: (paths: { [key: string]: Operator<User> }) => Operator<User> = (paths) =>
+  fork(function forkUserType(_, user) {
+    return user.type
+  }, paths)
 `,
         },
         {
-          fileName: 'overmind/actions.ts',
+          fileName: 'actions.ts',
           code: `
 import { Operator, pipe } from 'overmind'
-import { forkUserType, doThis, doThat } from './operators'
+import * as o from './operators'
 
 export const getUser: Operator<string, User> = pipe(
-  getUser,
-  forkUserType({
-    admin: doThis,
-    superuser: doThat
+  o.getUser(),
+  o.forkUserType({
+    admin: o.doThis(),
+    superuser: o.doThat()
   })
 )
           `,
         },
       ]
     : [
         {
-          fileName: 'overmind/operators.ts',
+          fileName: 'operators.js',
           code: `
 import { fork } from 'overmind'
 
-export const forkUserType = (paths) => fork(({ value: user }) => user.type, paths)
+export const forkUserType = (paths) =>
+  fork(function forkUserType(_, user) {
+    return user.type
+  }, paths)
 `,
         },
         {
-          fileName: 'overmind/actions.ts',
+          fileName: 'actions.js',
           code: `
 import { pipe } from 'overmind'
-import { forkUserType, doThis, doThat } from './operators'
+import * as o from './operators'
 
 export const getUser = pipe(
-  getUser,
-  forkUserType({
-    admin: doThis,
-    superuser: doThat
+  o.getUser(),
+  o.forkUserType({
+    admin: o.doThis(),
+    superuser: o.doThat()
   })
 )
         `,