Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
target = throttle(source, timeout)",id:"target--throttlesource-timeout",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Usage",id:"usage",level:3},{value:"throttle({ source, timeout, target })",id:"throttle-source-timeout-target-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Usage",id:"usage-1",level:3},{value:"Example with timeout as store",id:"example-with-timeout-as-store",level:3},{value:"target = throttle({ source, timeout })",id:"target--throttle-source-timeout-",level:2},{value:"Motivation",id:"motivation-2",level:3},{value:"Formulae",id:"formulae-2",level:3},{value:"Arguments",id:"arguments-2",level:3},{value:"Returns",id:"returns-2",level:3},{value:"Usage",id:"usage-2",level:3}],s={toc:p},u="wrapper";function c(e){let{components:t,...n}=e;return(0,a.kt)(u,(0,r.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"throttle"},"throttle"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { throttle } from 'patronum';\n// or\nimport { throttle } from 'patronum/throttle';\n")),(0,a.kt)("h2",{id:"target--throttlesource-timeout"},(0,a.kt)("inlineCode",{parentName:"h2"},"target = throttle(source, timeout)")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"This method allows to trigger ",(0,a.kt)("inlineCode",{parentName:"p"},"target")," in equal timeouts regardless of source trigger frequency.\nIt is useful in live search in UI."),(0,a.kt)("admonition",{title:"since",type:"note"},(0,a.kt)("p",{parentName:"admonition"},"patronum 2.1.0\nUse ",(0,a.kt)("inlineCode",{parentName:"p"},"throttle({ source, timeout })")," with patronum < 2.1.0")),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"target = throttle(source, timeout);\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Triggers ",(0,a.kt)("inlineCode",{parentName:"li"},"target")," at most once per ",(0,a.kt)("inlineCode",{parentName:"li"},"timeout")," after triggering ",(0,a.kt)("inlineCode",{parentName:"li"},"source"))),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"source")," (",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/event"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Event")))," | ",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Store")))," | ",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/effect"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Effect"))),") \u2014 Source unit, data from this unit used by the ",(0,a.kt)("inlineCode",{parentName:"li"},"target")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"timeout")," (",(0,a.kt)("a",{parentName:"li",href:"https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/Number"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"number")))," | ",(0,a.kt)("inlineCode",{parentName:"li"},"Storetarget = throttle({ source, timeout })",id:"target--throttle-source-timeout-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Usage",id:"usage",level:3},{value:"throttle({ source, timeout, target })",id:"throttle-source-timeout-target-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Returns",id:"returns-1",level:3},{value:"Usage",id:"usage-1",level:3},{value:"Example with timeout as store",id:"example-with-timeout-as-store",level:3}],s={toc:p};function u(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},s,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"throttle"},"throttle"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { throttle } from 'patronum';\n// or\nimport { throttle } from 'patronum/throttle';\n")),(0,a.kt)("h2",{id:"target--throttle-source-timeout-"},(0,a.kt)("inlineCode",{parentName:"h2"},"target = throttle({ source, timeout })")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"This method allows to trigger ",(0,a.kt)("inlineCode",{parentName:"p"},"target")," in equal timeouts regardless of source trigger frequency.\nIt is useful in live search in UI."),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"target = throttle({ source, timeout });\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Triggers ",(0,a.kt)("inlineCode",{parentName:"li"},"target")," at most once per ",(0,a.kt)("inlineCode",{parentName:"li"},"timeout")," after triggering ",(0,a.kt)("inlineCode",{parentName:"li"},"source"))),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"source")," (",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/event"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Event")))," | ",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Store")))," | ",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/effect"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Effect"))),") \u2014 Source unit, data from this unit used by the ",(0,a.kt)("inlineCode",{parentName:"li"},"target")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"timeout")," (",(0,a.kt)("a",{parentName:"li",href:"https://developer.mozilla.org/ru/docs/Web/JavaScript/Reference/Global_Objects/Number"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"number")))," | ",(0,a.kt)("inlineCode",{parentName:"li"},"Storeevery({ predicate: Function, stores })",id:"every-predicate-function-stores-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Return",id:"return",level:3},{value:"Example",id:"example",level:3},{value:"every({ predicate: value, stores })",id:"every-predicate-value-stores-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Return",id:"return-1",level:3},{value:"Example",id:"example-1",level:3},{value:"every({ predicate: Store, stores })",id:"every-predicate-store-stores-",level:2},{value:"Motivation",id:"motivation-2",level:3},{value:"Formulae",id:"formulae-2",level:3},{value:"Arguments",id:"arguments-2",level:3},{value:"Return",id:"return-2",level:3},{value:"Example",id:"example-2",level:3},{value:"Shorthands",id:"shorthands",level:2},{value:"Arguments",id:"arguments-3",level:3}],p={toc:u},m="wrapper";function d(e){let{components:t,...r}=e;return(0,a.kt)(m,(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"every"},"every"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { every } from 'patronum';\n// or\nimport { every } from 'patronum/every';\n")),(0,a.kt)("h2",{id:"every-predicate-function-stores-"},(0,a.kt)("inlineCode",{parentName:"h2"},"every({ predicate: Function, stores })")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"The method calculates boolean value if each store satisfies the condition in ",(0,a.kt)("inlineCode",{parentName:"p"},"predicate"),".\nIt is useful to check that user has correct values in each state."),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"$result = every({ predicate: fn, stores });\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"$result")," will be ",(0,a.kt)("inlineCode",{parentName:"li"},"true")," if each call ",(0,a.kt)("inlineCode",{parentName:"li"},"predicate")," on each store value from ",(0,a.kt)("inlineCode",{parentName:"li"},"values")," returns ",(0,a.kt)("inlineCode",{parentName:"li"},"true"),", otherwise it will be ",(0,a.kt)("inlineCode",{parentName:"li"},"false"))),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"predicate: (value: T) => boolean")," \u2014 Function to check store value"),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"stores: Arrayevery({ predicate: Function, stores })",id:"every-predicate-function-stores-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Return",id:"return",level:3},{value:"Example",id:"example",level:3},{value:"every({ predicate: value, stores })",id:"every-predicate-value-stores-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Return",id:"return-1",level:3},{value:"Example",id:"example-1",level:3},{value:"every({ predicate: Store, stores })",id:"every-predicate-store-stores-",level:2},{value:"Motivation",id:"motivation-2",level:3},{value:"Formulae",id:"formulae-2",level:3},{value:"Arguments",id:"arguments-2",level:3},{value:"Return",id:"return-2",level:3},{value:"Example",id:"example-2",level:3},{value:"Shorthands",id:"shorthands",level:2},{value:"Arguments",id:"arguments-3",level:3}],p={toc:u};function m(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"every"},"every"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { every } from 'patronum';\n// or\nimport { every } from 'patronum/every';\n")),(0,a.kt)("h2",{id:"every-predicate-function-stores-"},(0,a.kt)("inlineCode",{parentName:"h2"},"every({ predicate: Function, stores })")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"The method calculates boolean value if each store satisfies the condition in ",(0,a.kt)("inlineCode",{parentName:"p"},"predicate"),".\nIt is useful to check that user has correct values in each state."),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"$result = every({ predicate: fn, stores });\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"$result")," will be ",(0,a.kt)("inlineCode",{parentName:"li"},"true")," if each call ",(0,a.kt)("inlineCode",{parentName:"li"},"predicate")," on each store value from ",(0,a.kt)("inlineCode",{parentName:"li"},"values")," returns ",(0,a.kt)("inlineCode",{parentName:"li"},"true"),", otherwise it will be ",(0,a.kt)("inlineCode",{parentName:"li"},"false"))),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"predicate: (value: T) => boolean")," \u2014 Function to check store value"),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"stores: Arrayspread({ source, targets })",id:"spread-source-targets-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Example",id:"example",level:3},{value:"Save fields of payload to different stores",id:"save-fields-of-payload-to-different-stores",level:4},{value:"Call events on store changes",id:"call-events-on-store-changes",level:4},{value:"source = spread({ targets })",id:"source--spread-targets-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Returns",id:"returns",level:3},{value:"Example",id:"example-1",level:3},{value:"Conditionally save value to stores",id:"conditionally-save-value-to-stores",level:4},{value:"Nested spreading",id:"nested-spreading",level:4}],p={toc:d};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"spread"},"spread"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { spread } from 'patronum';\n// or\nimport { spread } from 'patronum/spread';\n")),(0,a.kt)("h2",{id:"spread-source-targets-"},(0,a.kt)("inlineCode",{parentName:"h2"},"spread({ source, targets })")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"This method allows to trigger many target at once, if they match the source structure.\nIt is useful when you need to destructure object and save values to different stores."),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"spread({ source, targets: { field: target, ... } })\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"When ",(0,a.kt)("inlineCode",{parentName:"li"},"source")," is triggered with ",(0,a.kt)("strong",{parentName:"li"},"object"),", extract ",(0,a.kt)("inlineCode",{parentName:"li"},"field")," from data, and trigger ",(0,a.kt)("inlineCode",{parentName:"li"},"target")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"targets")," can have multiple properties"),(0,a.kt)("li",{parentName:"ul"},"If the ",(0,a.kt)("inlineCode",{parentName:"li"},"source")," was triggered with non-object, nothing would be happening"),(0,a.kt)("li",{parentName:"ul"},"If ",(0,a.kt)("inlineCode",{parentName:"li"},"source")," is triggered with object but without propertpy ",(0,a.kt)("inlineCode",{parentName:"li"},"field"),", target for this ",(0,a.kt)("inlineCode",{parentName:"li"},"field")," will not be triggered")),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"source")," ",(0,a.kt)("inlineCode",{parentName:"li"},"(Eventsource = spread(targets)",id:"source--spreadtargets",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Example",id:"example",level:3},{value:"Conditionally save value to stores",id:"conditionally-save-value-to-stores",level:4},{value:"Nested spreading",id:"nested-spreading",level:4},{value:"spread({ source, targets })",id:"spread-source-targets-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Example",id:"example-1",level:3},{value:"Save fields of payload to different stores",id:"save-fields-of-payload-to-different-stores",level:4},{value:"Call events on store changes",id:"call-events-on-store-changes",level:4},{value:"source = spread({ targets })",id:"source--spread-targets-",level:2},{value:"Motivation",id:"motivation-2",level:3},{value:"Formulae",id:"formulae-2",level:3},{value:"Arguments",id:"arguments-2",level:3},{value:"Returns",id:"returns-1",level:3}],p={toc:d},u="wrapper";function c(e){let{components:t,...r}=e;return(0,n.kt)(u,(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("h1",{id:"spread"},"spread"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-ts"},"import { spread } from 'patronum';\n// or\nimport { spread } from 'patronum/spread';\n")),(0,n.kt)("h2",{id:"source--spreadtargets"},(0,n.kt)("inlineCode",{parentName:"h2"},"source = spread(targets)")),(0,n.kt)("admonition",{title:"since",type:"note"},(0,n.kt)("p",{parentName:"admonition"},"patronum 2.1.0\nUse ",(0,n.kt)("inlineCode",{parentName:"p"},"spread({ targets })")," with patronum < 2.1.0")),(0,n.kt)("h3",{id:"motivation"},"Motivation"),(0,n.kt)("p",null,"This method allows to trigger many target at once, if they match the source structure.\nIt is useful when you need to destructure object and save values to different stores."),(0,n.kt)("h3",{id:"formulae"},"Formulae"),(0,n.kt)("pre",null,(0,n.kt)("code",{parentName:"pre",className:"language-ts"},"source = spread({ field: target, ... })\n")),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"When ",(0,n.kt)("inlineCode",{parentName:"li"},"source")," is triggered with ",(0,n.kt)("strong",{parentName:"li"},"object"),", extract ",(0,n.kt)("inlineCode",{parentName:"li"},"field")," from data, and trigger ",(0,n.kt)("inlineCode",{parentName:"li"},"target")),(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("inlineCode",{parentName:"li"},"targets")," can have multiple properties"),(0,n.kt)("li",{parentName:"ul"},"If the ",(0,n.kt)("inlineCode",{parentName:"li"},"source")," was triggered with non-object, nothing would be happening"),(0,n.kt)("li",{parentName:"ul"},"If ",(0,n.kt)("inlineCode",{parentName:"li"},"source")," is triggered with object but without propertpy ",(0,n.kt)("inlineCode",{parentName:"li"},"field"),", target for this ",(0,n.kt)("inlineCode",{parentName:"li"},"field")," will not be triggered")),(0,n.kt)("h3",{id:"arguments"},"Arguments"),(0,n.kt)("ol",null,(0,n.kt)("li",{parentName:"ol"},(0,n.kt)("inlineCode",{parentName:"li"},"targets")," ",(0,n.kt)("inlineCode",{parentName:"li"},"(Recordresult = snapshot({ source, clock, fn })",id:"result--snapshot-source-clock-fn-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Examples",id:"examples",level:3},{value:"Exact copy of store",id:"exact-copy-of-store",level:4},{value:"Exact copy on trigger",id:"exact-copy-on-trigger",level:4},{value:"Copy on trigger with transformation",id:"copy-on-trigger-with-transformation",level:4}],c={toc:p};function m(e){let{components:t,...n}=e;return(0,o.kt)("wrapper",(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"snapshot"},"snapshot"),(0,o.kt)("admonition",{title:"since",type:"note"},(0,o.kt)("p",{parentName:"admonition"},"patronum 1.7.0")),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"import { snapshot } from 'patronum';\n// or\nimport { snapshot } from 'patronum/snapshot';\n")),(0,o.kt)("h2",{id:"result--snapshot-source-clock-fn-"},(0,o.kt)("inlineCode",{parentName:"h2"},"result = snapshot({ source, clock, fn })")),(0,o.kt)("h3",{id:"motivation"},"Motivation"),(0,o.kt)("p",null,"This method allows to copy any store on optional trigger unit.\nIt useful when you want to save previous state of store before some actions."),(0,o.kt)("h3",{id:"formulae"},"Formulae"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"result = snapshot({ source, clock, fn });\n")),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Call ",(0,o.kt)("inlineCode",{parentName:"li"},"fn")," with data from ",(0,o.kt)("inlineCode",{parentName:"li"},"source")," while ",(0,o.kt)("inlineCode",{parentName:"li"},"clock")," triggered, and create store with the value"),(0,o.kt)("li",{parentName:"ul"},"If ",(0,o.kt)("inlineCode",{parentName:"li"},"fn")," returns ",(0,o.kt)("inlineCode",{parentName:"li"},"undefined"),", the update will be skipped.")),(0,o.kt)("h3",{id:"arguments"},"Arguments"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("inlineCode",{parentName:"li"},"source")," (",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Source store, data from this unit passed to ",(0,o.kt)("inlineCode",{parentName:"li"},"fn")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("inlineCode",{parentName:"li"},"clock")," (",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/event"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Event"))),", ",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/effect"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Effect"))),", ",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Trigger unit"),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("inlineCode",{parentName:"li"},"fn")," ",(0,o.kt)("inlineCode",{parentName:"li"},"((value: T) => U)")," \u2014 Transformation function")),(0,o.kt)("h3",{id:"returns"},"Returns"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"result")," (",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Copied store")),(0,o.kt)("h3",{id:"examples"},"Examples"),(0,o.kt)("h4",{id:"exact-copy-of-store"},"Exact copy of store"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"import { createStore } from 'effector';\nimport { snapshot } from 'patronum/snapshot';\n\nconst $original = createStoreresult = snapshot({ source, clock, fn })",id:"result--snapshot-source-clock-fn-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Examples",id:"examples",level:3},{value:"Exact copy of store",id:"exact-copy-of-store",level:4},{value:"Exact copy on trigger",id:"exact-copy-on-trigger",level:4},{value:"Copy on trigger with transformation",id:"copy-on-trigger-with-transformation",level:4}],c={toc:p},m="wrapper";function u(e){let{components:t,...n}=e;return(0,o.kt)(m,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"snapshot"},"snapshot"),(0,o.kt)("admonition",{title:"since",type:"note"},(0,o.kt)("p",{parentName:"admonition"},"patronum 1.7.0")),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"import { snapshot } from 'patronum';\n// or\nimport { snapshot } from 'patronum/snapshot';\n")),(0,o.kt)("h2",{id:"result--snapshot-source-clock-fn-"},(0,o.kt)("inlineCode",{parentName:"h2"},"result = snapshot({ source, clock, fn })")),(0,o.kt)("h3",{id:"motivation"},"Motivation"),(0,o.kt)("p",null,"This method allows to copy any store on optional trigger unit.\nIt useful when you want to save previous state of store before some actions."),(0,o.kt)("h3",{id:"formulae"},"Formulae"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"result = snapshot({ source, clock, fn });\n")),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},"Call ",(0,o.kt)("inlineCode",{parentName:"li"},"fn")," with data from ",(0,o.kt)("inlineCode",{parentName:"li"},"source")," while ",(0,o.kt)("inlineCode",{parentName:"li"},"clock")," triggered, and create store with the value"),(0,o.kt)("li",{parentName:"ul"},"If ",(0,o.kt)("inlineCode",{parentName:"li"},"fn")," returns ",(0,o.kt)("inlineCode",{parentName:"li"},"undefined"),", the update will be skipped.")),(0,o.kt)("h3",{id:"arguments"},"Arguments"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("inlineCode",{parentName:"li"},"source")," (",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Source store, data from this unit passed to ",(0,o.kt)("inlineCode",{parentName:"li"},"fn")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("inlineCode",{parentName:"li"},"clock")," (",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/event"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Event"))),", ",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/effect"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Effect"))),", ",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Trigger unit"),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("inlineCode",{parentName:"li"},"fn")," ",(0,o.kt)("inlineCode",{parentName:"li"},"((value: T) => U)")," \u2014 Transformation function")),(0,o.kt)("h3",{id:"returns"},"Returns"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("inlineCode",{parentName:"li"},"result")," (",(0,o.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,o.kt)("em",{parentName:"a"},(0,o.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Copied store")),(0,o.kt)("h3",{id:"examples"},"Examples"),(0,o.kt)("h4",{id:"exact-copy-of-store"},"Exact copy of store"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre",className:"language-ts"},"import { createStore } from 'effector';\nimport { snapshot } from 'patronum/snapshot';\n\nconst $original = createStoresome({ predicate: Function, stores })",id:"some-predicate-function-stores-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Return",id:"return",level:3},{value:"Example",id:"example",level:3},{value:"some({ predicate: value, stores })",id:"some-predicate-value-stores-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Return",id:"return-1",level:3},{value:"Example",id:"example-1",level:3},{value:"some({ predicate: Store, stores })",id:"some-predicate-store-stores-",level:2},{value:"Motivation",id:"motivation-2",level:3},{value:"Formulae",id:"formulae-2",level:3},{value:"Arguments",id:"arguments-2",level:3},{value:"Return",id:"return-2",level:3},{value:"Example",id:"example-2",level:3},{value:"Shorthands",id:"shorthands",level:2},{value:"Arguments",id:"arguments-3",level:3}],p={toc:m};function u(e){let{components:t,...a}=e;return(0,r.kt)("wrapper",(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"some"},"some"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"import { some } from 'patronum';\n// or\nimport { some } from 'patronum/some';\n")),(0,r.kt)("h2",{id:"some-predicate-function-stores-"},(0,r.kt)("inlineCode",{parentName:"h2"},"some({ predicate: Function, stores })")),(0,r.kt)("h3",{id:"motivation"},"Motivation"),(0,r.kt)("p",null,"Method calculates boolean value if at least one state of the store satisfies the condition in ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),".\nIt is useful to check that user filled at least a single field."),(0,r.kt)("h3",{id:"formulae"},"Formulae"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"$result = some({ predicate: (value) => true, stores });\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"read it as: has some predicate at at least one store"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"$result")," will be ",(0,r.kt)("inlineCode",{parentName:"li"},"true")," if each at least ",(0,r.kt)("inlineCode",{parentName:"li"},"predicate")," on each store value from ",(0,r.kt)("inlineCode",{parentName:"li"},"values")," returns ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", otherwise it will be ",(0,r.kt)("inlineCode",{parentName:"li"},"false"))),(0,r.kt)("h3",{id:"arguments"},"Arguments"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"predicate")," ",(0,r.kt)("inlineCode",{parentName:"li"},"((value: T) => boolean)")," \u2014 Function to check store value"),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"stores")," ",(0,r.kt)("inlineCode",{parentName:"li"},"(Arraysome({ predicate: Function, stores })",id:"some-predicate-function-stores-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Return",id:"return",level:3},{value:"Example",id:"example",level:3},{value:"some({ predicate: value, stores })",id:"some-predicate-value-stores-",level:2},{value:"Motivation",id:"motivation-1",level:3},{value:"Formulae",id:"formulae-1",level:3},{value:"Arguments",id:"arguments-1",level:3},{value:"Return",id:"return-1",level:3},{value:"Example",id:"example-1",level:3},{value:"some({ predicate: Store, stores })",id:"some-predicate-store-stores-",level:2},{value:"Motivation",id:"motivation-2",level:3},{value:"Formulae",id:"formulae-2",level:3},{value:"Arguments",id:"arguments-2",level:3},{value:"Return",id:"return-2",level:3},{value:"Example",id:"example-2",level:3},{value:"Shorthands",id:"shorthands",level:2},{value:"Arguments",id:"arguments-3",level:3}],p={toc:m},u="wrapper";function d(e){let{components:t,...a}=e;return(0,r.kt)(u,(0,n.Z)({},p,a,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("h1",{id:"some"},"some"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"import { some } from 'patronum';\n// or\nimport { some } from 'patronum/some';\n")),(0,r.kt)("h2",{id:"some-predicate-function-stores-"},(0,r.kt)("inlineCode",{parentName:"h2"},"some({ predicate: Function, stores })")),(0,r.kt)("h3",{id:"motivation"},"Motivation"),(0,r.kt)("p",null,"Method calculates boolean value if at least one state of the store satisfies the condition in ",(0,r.kt)("inlineCode",{parentName:"p"},"predicate"),".\nIt is useful to check that user filled at least a single field."),(0,r.kt)("h3",{id:"formulae"},"Formulae"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-ts"},"$result = some({ predicate: (value) => true, stores });\n")),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"read it as: has some predicate at at least one store"),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("inlineCode",{parentName:"li"},"$result")," will be ",(0,r.kt)("inlineCode",{parentName:"li"},"true")," if each at least ",(0,r.kt)("inlineCode",{parentName:"li"},"predicate")," on each store value from ",(0,r.kt)("inlineCode",{parentName:"li"},"values")," returns ",(0,r.kt)("inlineCode",{parentName:"li"},"true"),", otherwise it will be ",(0,r.kt)("inlineCode",{parentName:"li"},"false"))),(0,r.kt)("h3",{id:"arguments"},"Arguments"),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"predicate")," ",(0,r.kt)("inlineCode",{parentName:"li"},"((value: T) => boolean)")," \u2014 Function to check store value"),(0,r.kt)("li",{parentName:"ol"},(0,r.kt)("inlineCode",{parentName:"li"},"stores")," ",(0,r.kt)("inlineCode",{parentName:"li"},"(Arrayresult = reshape({ source, shape })",id:"result--reshape-source-shape-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Examples",id:"examples",level:3},{value:"Creates much stores from single string",id:"creates-much-stores-from-single-string",level:4},{value:"Destructure object",id:"destructure-object",level:4}],u={toc:p};function c(e){let{components:t,...r}=e;return(0,a.kt)("wrapper",(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"reshape"},"reshape"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { reshape } from 'patronum';\n// or\nimport { reshape } from 'patronum/reshape';\n")),(0,a.kt)("h2",{id:"result--reshape-source-shape-"},(0,a.kt)("inlineCode",{parentName:"h2"},"result = reshape({ source, shape })")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"This method allows to create many stores from single store at once.\nIt useful when you want to read many properties from object to different stores."),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"result = reshape({ source, shape });\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Call each function in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")," object with data from ",(0,a.kt)("inlineCode",{parentName:"li"},"source"),", and create store with the same name as key in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")),(0,a.kt)("li",{parentName:"ul"},"If function in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")," returns ",(0,a.kt)("inlineCode",{parentName:"li"},"undefined"),", the same store will contain ",(0,a.kt)("inlineCode",{parentName:"li"},"null"),", because store cannot contain ",(0,a.kt)("inlineCode",{parentName:"li"},"undefined"),".")),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"source")," (",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Source store, data from this unit passed to each function in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"shape")," (",(0,a.kt)("inlineCode",{parentName:"li"},"{ [key: string]: (payload: T) => any }"),") \u2014 Object of functions. Function receives payload of ",(0,a.kt)("inlineCode",{parentName:"li"},"source")," as single argument, should return any value.")),(0,a.kt)("h3",{id:"returns"},"Returns"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"result")," (",(0,a.kt)("inlineCode",{parentName:"li"},"{ [key: string]: Storeresult = reshape({ source, shape })",id:"result--reshape-source-shape-",level:2},{value:"Motivation",id:"motivation",level:3},{value:"Formulae",id:"formulae",level:3},{value:"Arguments",id:"arguments",level:3},{value:"Returns",id:"returns",level:3},{value:"Examples",id:"examples",level:3},{value:"Creates much stores from single string",id:"creates-much-stores-from-single-string",level:4},{value:"Destructure object",id:"destructure-object",level:4}],u={toc:p},c="wrapper";function m(e){let{components:t,...r}=e;return(0,a.kt)(c,(0,n.Z)({},u,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h1",{id:"reshape"},"reshape"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"import { reshape } from 'patronum';\n// or\nimport { reshape } from 'patronum/reshape';\n")),(0,a.kt)("h2",{id:"result--reshape-source-shape-"},(0,a.kt)("inlineCode",{parentName:"h2"},"result = reshape({ source, shape })")),(0,a.kt)("h3",{id:"motivation"},"Motivation"),(0,a.kt)("p",null,"This method allows to create many stores from single store at once.\nIt useful when you want to read many properties from object to different stores."),(0,a.kt)("h3",{id:"formulae"},"Formulae"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-ts"},"result = reshape({ source, shape });\n")),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Call each function in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")," object with data from ",(0,a.kt)("inlineCode",{parentName:"li"},"source"),", and create store with the same name as key in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")),(0,a.kt)("li",{parentName:"ul"},"If function in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")," returns ",(0,a.kt)("inlineCode",{parentName:"li"},"undefined"),", the same store will contain ",(0,a.kt)("inlineCode",{parentName:"li"},"null"),", because store cannot contain ",(0,a.kt)("inlineCode",{parentName:"li"},"undefined"),".")),(0,a.kt)("h3",{id:"arguments"},"Arguments"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"source")," (",(0,a.kt)("a",{parentName:"li",href:"https://effector.dev/docs/api/effector/store"},(0,a.kt)("em",{parentName:"a"},(0,a.kt)("inlineCode",{parentName:"em"},"Store"))),") \u2014 Source store, data from this unit passed to each function in ",(0,a.kt)("inlineCode",{parentName:"li"},"shape")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("inlineCode",{parentName:"li"},"shape")," (",(0,a.kt)("inlineCode",{parentName:"li"},"{ [key: string]: (payload: T) => any }"),") \u2014 Object of functions. Function receives payload of ",(0,a.kt)("inlineCode",{parentName:"li"},"source")," as single argument, should return any value.")),(0,a.kt)("h3",{id:"returns"},"Returns"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("inlineCode",{parentName:"li"},"result")," (",(0,a.kt)("inlineCode",{parentName:"li"},"{ [key: string]: Store