1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["38171"],{81233(e,r,s){s.r(r),s.d(r,{metadata:()=>n,default:()=>o,frontMatter:()=>i,contentTitle:()=>l,toc:()=>t,assets:()=>h});var n=JSON.parse('{"id":"api/interfaces/IRawProperty","title":"Interface: IRawProperty\\\\<Ts, IsAsync\\\\>","description":"Defined in32","source":"@site/docs/api/interfaces/IRawProperty.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/IRawProperty","permalink":"/docs/api/interfaces/IRawProperty","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedBy":null,"lastUpdatedAt":null,"frontMatter":{"mdx":{"format":"md"}},"sidebar":"tutorialSidebar","previous":{"title":"Interface: IPropertyWithHooks\\\\<Ts\\\\>","permalink":"/docs/api/interfaces/IPropertyWithHooks"},"next":{"title":"Interface: IntegerConstraints","permalink":"/docs/api/interfaces/IntegerConstraints"}}'),c=s(61058),d=s(24801);let i={mdx:{format:"md"}},l="Interface: IRawProperty<Ts, IsAsync>",h={},t=[{value:"Remarks",id:"remarks",level:2},{value:"Extended by",id:"extended-by",level:2},{value:"Type Parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"runAfterEach",id:"runaftereach",level:3},{value:"Returns",id:"returns",level:4},{value:"Remarks",id:"remarks-1",level:4},{value:"runBeforeEach",id:"runbeforeeach",level:3},{value:"Returns",id:"returns-1",level:4},{value:"Remarks",id:"remarks-2",level:4},{value:"Methods",id:"methods",level:2},{value:"generate()",id:"generate",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Remarks",id:"remarks-3",level:4},{value:"isAsync()",id:"isasync-1",level:3},{value:"Returns",id:"returns-3",level:4},{value:"Remarks",id:"remarks-4",level:4},{value:"run()",id:"run",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Remarks",id:"remarks-5",level:4},{value:"shrink()",id:"shrink",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Remarks",id:"remarks-6",level:4}];function a(e){let r={a:"a",blockquote:"blockquote",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,d.R)(),...e.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(r.header,{children:(0,c.jsx)(r.h1,{id:"interface-irawpropertyts-isasync",children:"Interface: IRawProperty<Ts, IsAsync>"})}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L32",children:"packages/fast-check/src/check/property/IRawProperty.ts:32"})]}),"\n",(0,c.jsx)(r.p,{children:"Property"}),"\n",(0,c.jsx)(r.p,{children:"A property is the combination of:"}),"\n",(0,c.jsxs)(r.ul,{children:["\n",(0,c.jsx)(r.li,{children:"Arbitraries: how to generate the inputs for the algorithm"}),"\n",(0,c.jsx)(r.li,{children:"Predicate: how to confirm the algorithm succeeded?"}),"\n"]}),"\n",(0,c.jsx)(r.h2,{id:"remarks",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 1.19.0"}),"\n",(0,c.jsx)(r.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,c.jsxs)(r.ul,{children:["\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/api/interfaces/IProperty",children:(0,c.jsx)(r.code,{children:"IProperty"})})}),"\n",(0,c.jsx)(r.li,{children:(0,c.jsx)(r.a,{href:"/docs/api/interfaces/IAsyncProperty",children:(0,c.jsx)(r.code,{children:"IAsyncProperty"})})}),"\n"]}),"\n",(0,c.jsx)(r.h2,{id:"type-parameters",children:"Type Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,c.jsxs)(r.table,{children:[(0,c.jsx)(r.thead,{children:(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.th,{children:"Type Parameter"}),(0,c.jsx)(r.th,{children:"Default type"})]})}),(0,c.jsxs)(r.tbody,{children:[(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"Ts"})}),(0,c.jsx)(r.td,{children:"-"})]}),(0,c.jsxs)(r.tr,{children:[(0,c.jsxs)(r.td,{children:[(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"boolean"})]}),(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"boolean"})})]})]})]}),"\n",(0,c.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,c.jsx)(r.h3,{id:"runaftereach",children:"runAfterEach"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"runAfterEach"}),": () => ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"true"})," ? ",(0,c.jsx)(r.code,{children:"Promise"}),"<",(0,c.jsx)(r.code,{children:"void"}),"> : ",(0,c.jsx)(r.code,{children:"never"})," | ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"false"})," ? ",(0,c.jsx)(r.code,{children:"void"})," : ",(0,c.jsx)(r.code,{children:"never"})]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L81",children:"packages/fast-check/src/check/property/IRawProperty.ts:81"})]}),"\n",(0,c.jsx)(r.p,{children:"Run after each hook"}),"\n",(0,c.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"true"})," ? ",(0,c.jsx)(r.code,{children:"Promise"}),"<",(0,c.jsx)(r.code,{children:"void"}),"> : ",(0,c.jsx)(r.code,{children:"never"})," | ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"false"})," ? ",(0,c.jsx)(r.code,{children:"void"})," : ",(0,c.jsx)(r.code,{children:"never"})]}),"\n",(0,c.jsx)(r.h4,{id:"remarks-1",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 3.4.0"}),"\n",(0,c.jsx)(r.hr,{}),"\n",(0,c.jsx)(r.h3,{id:"runbeforeeach",children:"runBeforeEach"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"runBeforeEach"}),": () => ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"true"})," ? ",(0,c.jsx)(r.code,{children:"Promise"}),"<",(0,c.jsx)(r.code,{children:"void"}),"> : ",(0,c.jsx)(r.code,{children:"never"})," | ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"false"})," ? ",(0,c.jsx)(r.code,{children:"void"})," : ",(0,c.jsx)(r.code,{children:"never"})]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L75",children:"packages/fast-check/src/check/property/IRawProperty.ts:75"})]}),"\n",(0,c.jsx)(r.p,{children:"Run before each hook"}),"\n",(0,c.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"true"})," ? ",(0,c.jsx)(r.code,{children:"Promise"}),"<",(0,c.jsx)(r.code,{children:"void"}),"> : ",(0,c.jsx)(r.code,{children:"never"})," | ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"false"})," ? ",(0,c.jsx)(r.code,{children:"void"})," : ",(0,c.jsx)(r.code,{children:"never"})]}),"\n",(0,c.jsx)(r.h4,{id:"remarks-2",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 3.4.0"}),"\n",(0,c.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,c.jsx)(r.h3,{id:"generate",children:"generate()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"generate"}),"(",(0,c.jsx)(r.code,{children:"mrng"}),", ",(0,c.jsx)(r.code,{children:"runId?"}),"): ",(0,c.jsx)(r.a,{href:"/docs/api/classes/Value",children:(0,c.jsx)(r.code,{children:"Value"})}),"<",(0,c.jsx)(r.code,{children:"Ts"}),">"]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L49",children:"packages/fast-check/src/check/property/IRawProperty.ts:49"})]}),"\n",(0,c.jsx)(r.p,{children:"Generate values of type Ts"}),"\n",(0,c.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,c.jsxs)(r.table,{children:[(0,c.jsx)(r.thead,{children:(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.th,{children:"Parameter"}),(0,c.jsx)(r.th,{children:"Type"}),(0,c.jsx)(r.th,{children:"Description"})]})}),(0,c.jsxs)(r.tbody,{children:[(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"mrng"})}),(0,c.jsx)(r.td,{children:(0,c.jsx)(r.a,{href:"/docs/api/classes/Random",children:(0,c.jsx)(r.code,{children:"Random"})})}),(0,c.jsx)(r.td,{children:"Random number generator"})]}),(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"runId?"})}),(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"number"})}),(0,c.jsx)(r.td,{children:"Id of the generation, starting at 0 - if set the generation might be biased"})]})]})]}),"\n",(0,c.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/docs/api/classes/Value",children:(0,c.jsx)(r.code,{children:"Value"})}),"<",(0,c.jsx)(r.code,{children:"Ts"}),">"]}),"\n",(0,c.jsx)(r.h4,{id:"remarks-3",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 0.0.7 (return type changed in 3.0.0)"}),"\n",(0,c.jsx)(r.hr,{}),"\n",(0,c.jsx)(r.h3,{id:"isasync-1",children:"isAsync()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"isAsync"}),"(): ",(0,c.jsx)(r.code,{children:"IsAsync"})]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L39",children:"packages/fast-check/src/check/property/IRawProperty.ts:39"})]}),"\n",(0,c.jsx)(r.p,{children:"Is the property asynchronous?"}),"\n",(0,c.jsx)(r.p,{children:"true in case of asynchronous property, false otherwise"}),"\n",(0,c.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,c.jsx)(r.p,{children:(0,c.jsx)(r.code,{children:"IsAsync"})}),"\n",(0,c.jsx)(r.h4,{id:"remarks-4",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 0.0.7"}),"\n",(0,c.jsx)(r.hr,{}),"\n",(0,c.jsx)(r.h3,{id:"run",children:"run()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"run"}),"(",(0,c.jsx)(r.code,{children:"v"}),"): ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"true"})," ? ",(0,c.jsx)(r.code,{children:"Promise"}),"<",(0,c.jsx)(r.a,{href:"/docs/api/classes/PreconditionFailure",children:(0,c.jsx)(r.code,{children:"PreconditionFailure"})})," | ",(0,c.jsx)(r.a,{href:"/docs/api/type-aliases/PropertyFailure",children:(0,c.jsx)(r.code,{children:"PropertyFailure"})})," | ",(0,c.jsx)(r.code,{children:"null"}),"> : ",(0,c.jsx)(r.code,{children:"never"})," | ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"false"})," ? ",(0,c.jsx)(r.a,{href:"/docs/api/classes/PreconditionFailure",children:(0,c.jsx)(r.code,{children:"PreconditionFailure"})})," | ",(0,c.jsx)(r.a,{href:"/docs/api/type-aliases/PropertyFailure",children:(0,c.jsx)(r.code,{children:"PropertyFailure"})})," | ",(0,c.jsx)(r.code,{children:"null"})," : ",(0,c.jsx)(r.code,{children:"never"})]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L65",children:"packages/fast-check/src/check/property/IRawProperty.ts:65"})]}),"\n",(0,c.jsx)(r.p,{children:"Check the predicate for v"}),"\n",(0,c.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,c.jsxs)(r.table,{children:[(0,c.jsx)(r.thead,{children:(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.th,{children:"Parameter"}),(0,c.jsx)(r.th,{children:"Type"}),(0,c.jsx)(r.th,{children:"Description"})]})}),(0,c.jsx)(r.tbody,{children:(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"v"})}),(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"Ts"})}),(0,c.jsx)(r.td,{children:"Value of which we want to check the predicate"})]})})]}),"\n",(0,c.jsx)(r.h4,{id:"returns-4",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"true"})," ? ",(0,c.jsx)(r.code,{children:"Promise"}),"<",(0,c.jsx)(r.a,{href:"/docs/api/classes/PreconditionFailure",children:(0,c.jsx)(r.code,{children:"PreconditionFailure"})})," | ",(0,c.jsx)(r.a,{href:"/docs/api/type-aliases/PropertyFailure",children:(0,c.jsx)(r.code,{children:"PropertyFailure"})})," | ",(0,c.jsx)(r.code,{children:"null"}),"> : ",(0,c.jsx)(r.code,{children:"never"})," | ",(0,c.jsx)(r.code,{children:"IsAsync"})," ",(0,c.jsx)(r.em,{children:"extends"})," ",(0,c.jsx)(r.code,{children:"false"})," ? ",(0,c.jsx)(r.a,{href:"/docs/api/classes/PreconditionFailure",children:(0,c.jsx)(r.code,{children:"PreconditionFailure"})})," | ",(0,c.jsx)(r.a,{href:"/docs/api/type-aliases/PropertyFailure",children:(0,c.jsx)(r.code,{children:"PropertyFailure"})})," | ",(0,c.jsx)(r.code,{children:"null"})," : ",(0,c.jsx)(r.code,{children:"never"})]}),"\n",(0,c.jsx)(r.h4,{id:"remarks-5",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 0.0.7"}),"\n",(0,c.jsx)(r.hr,{}),"\n",(0,c.jsx)(r.h3,{id:"shrink",children:"shrink()"}),"\n",(0,c.jsxs)(r.blockquote,{children:["\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.strong,{children:"shrink"}),"(",(0,c.jsx)(r.code,{children:"value"}),"): ",(0,c.jsx)(r.a,{href:"/docs/api/classes/Stream",children:(0,c.jsx)(r.code,{children:"Stream"})}),"<",(0,c.jsx)(r.a,{href:"/docs/api/classes/Value",children:(0,c.jsx)(r.code,{children:"Value"})}),"<",(0,c.jsx)(r.code,{children:"Ts"}),">>"]}),"\n"]}),"\n",(0,c.jsxs)(r.p,{children:["Defined in: ",(0,c.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/check/property/IRawProperty.ts#L58",children:"packages/fast-check/src/check/property/IRawProperty.ts:58"})]}),"\n",(0,c.jsx)(r.p,{children:"Shrink value of type Ts"}),"\n",(0,c.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,c.jsxs)(r.table,{children:[(0,c.jsx)(r.thead,{children:(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.th,{children:"Parameter"}),(0,c.jsx)(r.th,{children:"Type"}),(0,c.jsx)(r.th,{children:"Description"})]})}),(0,c.jsx)(r.tbody,{children:(0,c.jsxs)(r.tr,{children:[(0,c.jsx)(r.td,{children:(0,c.jsx)(r.code,{children:"value"})}),(0,c.jsxs)(r.td,{children:[(0,c.jsx)(r.a,{href:"/docs/api/classes/Value",children:(0,c.jsx)(r.code,{children:"Value"})}),"<",(0,c.jsx)(r.code,{children:"Ts"}),">"]}),(0,c.jsx)(r.td,{children:"The value to be shrunk, it can be context-less"})]})})]}),"\n",(0,c.jsx)(r.h4,{id:"returns-5",children:"Returns"}),"\n",(0,c.jsxs)(r.p,{children:[(0,c.jsx)(r.a,{href:"/docs/api/classes/Stream",children:(0,c.jsx)(r.code,{children:"Stream"})}),"<",(0,c.jsx)(r.a,{href:"/docs/api/classes/Value",children:(0,c.jsx)(r.code,{children:"Value"})}),"<",(0,c.jsx)(r.code,{children:"Ts"}),">>"]}),"\n",(0,c.jsx)(r.h4,{id:"remarks-6",children:"Remarks"}),"\n",(0,c.jsx)(r.p,{children:"Since 3.0.0"})]})}function o(e={}){let{wrapper:r}={...(0,d.R)(),...e.components};return r?(0,c.jsx)(r,{...e,children:(0,c.jsx)(a,{...e})}):a(e)}},24801(e,r,s){s.d(r,{R:()=>i,x:()=>l});var n=s(13706);let c={},d=n.createContext(c);function i(e){let r=n.useContext(d);return n.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function l(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(c):e.components||c:i(e.components),n.createElement(d.Provi
1der,{value:r},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.