https://fast-check.dev/assets/js/e0100247.d6438fb1.js

1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["31607"],{62737(e,r,s){s.r(r),s.d(r,{metadata:()=>t,default:()=>o,frontMatter:()=>a,contentTitle:()=>c,toc:()=>d,assets:()=>l});var t=JSON.parse('{"id":"api/interfaces/WebAuthorityConstraints","title":"Interface: WebAuthorityConstraints","description":"Defined in55","source":"@site/docs/api/interfaces/WebAuthorityConstraints.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/WebAuthorityConstraints","permalink":"/docs/api/interfaces/WebAuthorityConstraints","draft":false,"unlisted":false,"tags":[],"version":"current","lastUpdatedBy":null,"lastUpdatedAt":null,"frontMatter":{"mdx":{"format":"md"}},"sidebar":"tutorialSidebar","previous":{"title":"Interface: UuidConstraints","permalink":"/docs/api/interfaces/UuidConstraints"},"next":{"title":"Interface: WebFragmentsConstraints","permalink":"/docs/api/interfaces/WebFragmentsConstraints"}}'),n=s(61058),i=s(24801);let a={mdx:{format:"md"}},c="Interface: WebAuthorityConstraints",l={},d=[{value:"Remarks",id:"remarks",level:2},{value:"Properties",id:"properties",level:2},{value:"size?",id:"size",level:3},{value:"Remarks",id:"remarks-1",level:4},{value:"withIPv4?",id:"withipv4",level:3},{value:"Default Value",id:"default-value",level:4},{value:"Remarks",id:"remarks-2",level:4},{value:"withIPv4Extended?",id:"withipv4extended",level:3},{value:"Default Value",id:"default-value-1",level:4},{value:"Remarks",id:"remarks-3",level:4},{value:"withIPv6?",id:"withipv6",level:3},{value:"Default Value",id:"default-value-2",level:4},{value:"Remarks",id:"remarks-4",level:4},{value:"withPort?",id:"withport",level:3},{value:"Default Value",id:"default-value-3",level:4},{value:"Remarks",id:"remarks-5",level:4},{value:"withUserInfo?",id:"withuserinfo",level:3},{value:"Default Value",id:"default-value-4",level:4},{value:"Remarks",id:"remarks-6",level:4}];function h(e){let r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"interface-webauthorityconstraints",children:"Interface: WebAuthorityConstraints"})}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L55",children:"packages/fast-check/src/arbitrary/webAuthority.ts:55"})]}),"\n",(0,n.jsxs)(r.p,{children:["Constraints to be applied on ",(0,n.jsx)(r.a,{href:"/docs/api/functions/webAuthority",children:"webAuthority"})]}),"\n",(0,n.jsx)(r.h2,{id:"remarks",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 1.14.0"}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"size",children:"size?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"size?"}),": ",(0,n.jsx)(r.code,{children:"RelativeSize"})," | ",(0,n.jsx)(r.a,{href:"/docs/api/type-aliases/Size",children:(0,n.jsx)(r.code,{children:"Size"})})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L90",children:"packages/fast-check/src/arbitrary/webAuthority.ts:90"})]}),"\n",(0,n.jsx)(r.p,{children:"Define how large the generated values should be (at max)"}),"\n",(0,n.jsx)(r.h4,{id:"remarks-1",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 2.22.0"}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"withipv4",children:"withIPv4?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"withIPv4?"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L61",children:"packages/fast-check/src/arbitrary/webAuthority.ts:61"})]}),"\n",(0,n.jsx)(r.p,{children:"Enable IPv4 in host"}),"\n",(0,n.jsx)(r.h4,{id:"default-value",children:"Default Value"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:"false\n"})}),"\n",(0,n.jsx)(r.h4,{id:"remarks-2",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 1.14.0"}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"withipv4extended",children:"withIPv4Extended?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"withIPv4Extended?"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L73",children:"packages/fast-check/src/arbitrary/webAuthority.ts:73"})]}),"\n",(0,n.jsx)(r.p,{children:"Enable extended IPv4 format"}),"\n",(0,n.jsx)(r.h4,{id:"default-value-1",children:"Default Value"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:"false\n"})}),"\n",(0,n.jsx)(r.h4,{id:"remarks-3",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 1.17.0"}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"withipv6",children:"withIPv6?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"withIPv6?"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L67",children:"packages/fast-check/src/arbitrary/webAuthority.ts:67"})]}),"\n",(0,n.jsx)(r.p,{children:"Enable IPv6 in host"}),"\n",(0,n.jsx)(r.h4,{id:"default-value-2",children:"Default Value"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:"false\n"})}),"\n",(0,n.jsx)(r.h4,{id:"remarks-4",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 1.14.0"}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"withport",children:"withPort?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"withPort?"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L85",children:"packages/fast-check/src/arbitrary/webAuthority.ts:85"})]}),"\n",(0,n.jsx)(r.p,{children:"Enable port suffix"}),"\n",(0,n.jsx)(r.h4,{id:"default-value-3",children:"Default Value"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:"false\n"})}),"\n",(0,n.jsx)(r.h4,{id:"remarks-5",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 1.14.0"}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"withuserinfo",children:"withUserInfo?"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"optional"})," ",(0,n.jsx)(r.strong,{children:"withUserInfo?"}),": ",(0,n.jsx)(r.code,{children:"boolean"})]}),"\n"]}),"\n",(0,n.jsxs)(r.p,{children:["Defined in: ",(0,n.jsx)(r.a,{href:"https://github.com/dubzzz/fast-check/blob/014cc87e29e807fd7028e4cc05d8a6cd12da172b/packages/fast-check/src/arbitrary/webAuthority.ts#L79",children:"packages/fast-check/src/arbitrary/webAuthority.ts:79"})]}),"\n",(0,n.jsx)(r.p,{children:"Enable user information prefix"}),"\n",(0,n.jsx)(r.h4,{id:"default-value-4",children:"Default Value"}),"\n",(0,n.jsx)(r.pre,{children:(0,n.jsx)(r.code,{className:"language-ts",children:"false\n"})}),"\n",(0,n.jsx)(r.h4,{id:"remarks-6",children:"Remarks"}),"\n",(0,n.jsx)(r.p,{children:"Since 1.14.0"})]})}function o(e={}){let{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(h,{...e})}):h(e)}},24801(e,r,s){s.d(r,{R:()=>a,x:()=>c});var t=s(13706);let n={},i=t.createContext(n);function a(e){let r=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:a(e.components),t.createElement(i.Provider,{value:r},e.children)}}}]);