diff --git a/404.html b/404.html index 809d7db7..b9269578 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ 페이지를 찾을 수 없습니다. | @nf-team/frontend-libraries - + diff --git a/assets/js/1005e1dd.54d7e93e.js b/assets/js/1005e1dd.a6f95f1e.js similarity index 97% rename from assets/js/1005e1dd.54d7e93e.js rename to assets/js/1005e1dd.a6f95f1e.js index b5e68f3a..8480c750 100644 --- a/assets/js/1005e1dd.54d7e93e.js +++ b/assets/js/1005e1dd.a6f95f1e.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[453],{8422:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>o,frontMatter:()=>i,metadata:()=>d,toc:()=>h});var r=s(2322),n=s(5392);const i={id:"modules",title:"@nf-team/fetch - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},l=void 0,d={id:"fetch/modules",title:"@nf-team/fetch - v1.1.0",description:"Classes",source:"@site/docs/fetch/modules.md",sourceDirName:"fetch",slug:"/fetch/modules",permalink:"/frontend-libraries/docs/fetch/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/fetch - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/fetch/"},next:{title:"FetchError",permalink:"/frontend-libraries/docs/fetch/classes/FetchError"}},c={},h=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"Method",id:"method",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Functions",id:"functions",level:2},{value:"fetchApi",id:"fetchapi",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"paramsSerializer",id:"paramsserializer",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/classes/FetchError",children:"FetchError"})}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest",children:"FetchApiRequest"})}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsx)(t.h3,{id:"method",children:"Method"}),"\n",(0,r.jsxs)(t.p,{children:["\u01ac ",(0,r.jsx)(t.strong,{children:"Method"}),": ",(0,r.jsx)(t.code,{children:'"GET"'})," | ",(0,r.jsx)(t.code,{children:'"POST"'})," | ",(0,r.jsx)(t.code,{children:'"PUT"'})," | ",(0,r.jsx)(t.code,{children:'"DELETE"'})," | ",(0,r.jsx)(t.code,{children:'"PATCH"'})]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L12",children:"packages/fetch/src/fetch.ts:12"})}),"\n",(0,r.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(t.h3,{id:"fetchapi",children:"fetchApi"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"fetchApi"}),"<",(0,r.jsx)(t.code,{children:"T"}),", ",(0,r.jsx)(t.code,{children:"K"}),">(",(0,r.jsx)(t.code,{children:"\xabdestructured\xbb"}),"): ",(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,r.jsx)(t.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"K"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"unknown"})})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"\xabdestructured\xbb"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,r.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest",children:(0,r.jsx)(t.code,{children:"FetchApiRequest"})}),"<",(0,r.jsx)(t.code,{children:"K"}),">"]})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L28",children:"packages/fetch/src/fetch.ts:28"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"paramsserializer",children:"paramsSerializer"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"paramsSerializer"}),"<",(0,r.jsx)(t.code,{children:"T"}),">(",(0,r.jsx)(t.code,{children:"params"}),"): ",(0,r.jsx)(t.code,{children:"string"})]}),"\n",(0,r.jsx)(t.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsx)(t.tr,{children:(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(t.tbody,{children:(0,r.jsx)(t.tr,{children:(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"params"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"string"})}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L23",children:"packages/fetch/src/fetch.ts:23"})})]})}function o(e={}){const{wrapper:t}={...(0,n.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},5392:(e,t,s)=>{s.d(t,{Z:()=>d,a:()=>l});var r=s(2784);const n={},i=r.createContext(n);function l(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[453],{8422:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>o,frontMatter:()=>i,metadata:()=>d,toc:()=>h});var r=s(2322),n=s(5392);const i={id:"modules",title:"@nf-team/fetch - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},l=void 0,d={id:"fetch/modules",title:"@nf-team/fetch - v1.1.0",description:"Classes",source:"@site/docs/fetch/modules.md",sourceDirName:"fetch",slug:"/fetch/modules",permalink:"/frontend-libraries/docs/fetch/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/fetch - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/fetch/"},next:{title:"FetchError",permalink:"/frontend-libraries/docs/fetch/classes/FetchError"}},c={},h=[{value:"Classes",id:"classes",level:2},{value:"Interfaces",id:"interfaces",level:2},{value:"Type Aliases",id:"type-aliases",level:2},{value:"Method",id:"method",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"Functions",id:"functions",level:2},{value:"fetchApi",id:"fetchapi",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"paramsSerializer",id:"paramsserializer",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,n.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.h2,{id:"classes",children:"Classes"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/classes/FetchError",children:"FetchError"})}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"interfaces",children:"Interfaces"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest",children:"FetchApiRequest"})}),"\n"]}),"\n",(0,r.jsx)(t.h2,{id:"type-aliases",children:"Type Aliases"}),"\n",(0,r.jsx)(t.h3,{id:"method",children:"Method"}),"\n",(0,r.jsxs)(t.p,{children:["\u01ac ",(0,r.jsx)(t.strong,{children:"Method"}),": ",(0,r.jsx)(t.code,{children:'"GET"'})," | ",(0,r.jsx)(t.code,{children:'"POST"'})," | ",(0,r.jsx)(t.code,{children:'"PUT"'})," | ",(0,r.jsx)(t.code,{children:'"DELETE"'})," | ",(0,r.jsx)(t.code,{children:'"PATCH"'})]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L12",children:"packages/fetch/src/fetch.ts:12"})}),"\n",(0,r.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(t.h3,{id:"fetchapi",children:"fetchApi"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"fetchApi"}),"<",(0,r.jsx)(t.code,{children:"T"}),", ",(0,r.jsx)(t.code,{children:"K"}),">(",(0,r.jsx)(t.code,{children:"\xabdestructured\xbb"}),"): ",(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,r.jsx)(t.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"K"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"unknown"})})]})]})]}),"\n",(0,r.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"\xabdestructured\xbb"})}),(0,r.jsxs)(t.td,{style:{textAlign:"left"},children:[(0,r.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest",children:(0,r.jsx)(t.code,{children:"FetchApiRequest"})}),"<",(0,r.jsx)(t.code,{children:"K"}),">"]})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(t.p,{children:[(0,r.jsx)(t.code,{children:"Promise"}),"<",(0,r.jsx)(t.code,{children:"T"}),">"]}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L28",children:"packages/fetch/src/fetch.ts:28"})}),"\n",(0,r.jsx)(t.hr,{}),"\n",(0,r.jsx)(t.h3,{id:"paramsserializer",children:"paramsSerializer"}),"\n",(0,r.jsxs)(t.p,{children:["\u25b8 ",(0,r.jsx)(t.strong,{children:"paramsSerializer"}),"<",(0,r.jsx)(t.code,{children:"T"}),">(",(0,r.jsx)(t.code,{children:"params"}),"): ",(0,r.jsx)(t.code,{children:"string"})]}),"\n",(0,r.jsx)(t.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsx)(t.tr,{children:(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(t.tbody,{children:(0,r.jsx)(t.tr,{children:(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(t.tbody,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"params"})}),(0,r.jsx)(t.td,{style:{textAlign:"left"},children:(0,r.jsx)(t.code,{children:"T"})})]})})]}),"\n",(0,r.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.code,{children:"string"})}),"\n",(0,r.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(t.p,{children:(0,r.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L23",children:"packages/fetch/src/fetch.ts:23"})})]})}function o(e={}){const{wrapper:t}={...(0,n.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},5392:(e,t,s)=>{s.d(t,{Z:()=>d,a:()=>l});var r=s(2784);const n={},i=r.createContext(n);function l(e){const t=r.useContext(i);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/2ba16459.3e1b56cf.js b/assets/js/2ba16459.04cd6a13.js similarity index 97% rename from assets/js/2ba16459.3e1b56cf.js rename to assets/js/2ba16459.04cd6a13.js index 59befa1d..54f3fe39 100644 --- a/assets/js/2ba16459.3e1b56cf.js +++ b/assets/js/2ba16459.04cd6a13.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[862],{9627:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>o});var l=t(2322),r=t(5392);const s={id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},d=void 0,i={id:"react/modules/components",title:"Module: components",description:"Functions",source:"@site/docs/react/modules/components.md",sourceDirName:"react/modules",slug:"/react/modules/components",permalink:"/frontend-libraries/docs/react/modules/components",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Exports",permalink:"/frontend-libraries/docs/react/modules"},next:{title:"hooks",permalink:"/frontend-libraries/docs/react/modules/hooks"}},c={},o=[{value:"Functions",id:"functions",level:2},{value:"ClientOnly",id:"clientonly",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"DelayRenderComponent",id:"delayrendercomponent",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"GlobalPortal",id:"globalportal",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"clientonly",children:"ClientOnly"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"ClientOnly"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Object"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,l.jsx)(n.code,{children:"children?"})]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"ReactNode"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\uc5ec mount\uac00 \ub41c \uacbd\uc6b0, Component\ub97c render\ud574\uc90d\ub2c8\ub2e4.\nmount\ub418\uc9c0 \uc54a\uc740 \uacbd\uc6b0\uc5d0\ub294 Component\ub97c render\ud574\uc8fc\uc9c0 \uc54a\uc2b5\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0\ub9cc \ud574\ub2f9 Component\ub97c \ubcf4\uc5ec\uc8fc\uace0 \uc2f6\uc744\ub54c \uc0ac\uc6a9\ud569\ub2c8\ub2e4.\n(SSR \ud658\uacbd\uc5d0\uc11c Hydration \uc624\ub958\ub85c \uc778\ud574\uc11c \uc5d0\ub7ec\uac00 \ubc1c\uc0dd\ud558\ub294 \ubb38\uc81c\ub97c \ud574\uacb0\ud569\ub2c8\ub2e4.)"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function ClintOnlyComponent() {\n return (\n \n
Render only client environment
\n \n );\n}\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/components/ClientOnly.tsx#L22",children:"packages/react/src/components/ClientOnly.tsx:22"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"delayrendercomponent",children:"DelayRenderComponent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"DelayRenderComponent"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/components/DelayRenderComponent.tsx#L12",children:"packages/react/src/components/DelayRenderComponent.tsx:12"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"globalportal",children:"GlobalPortal"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"GlobalPortal"}),"(",(0,l.jsx)(n.code,{children:"elementId"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"elementId"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uac00 \uc544\ub2cc \ub2e4\ub978 DOM \ud2b8\ub9ac\uc758 elementId\uac12"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc758 DOM \uc678\ubd80\uc5d0 \uc874\uc7ac\ud558\ub294 DOM \ub178\ub4dc\uc5d0 \ub80c\ub354\ub9c1 \ud560 \uc218 \uc788\uac8c \ud574\uc8fc\ub294\n",(0,l.jsx)(n.code,{children:"ReactDOM.createPortal"}),"\ub97c \uc774\uc6a9\ud574 \ucef4\ud3ec\ub10c\ud2b8\ub97c \ub80c\ub354\ub9c1\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\uacf5\ud1b5\uc801\uc778 UI(\ubaa8\ub2ec, \ud31d\uc5c5, \uc54c\ub9bc \ub4f1)\ub098 \ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc5d0\n",(0,l.jsx)(n.code,{children:"overflow: hidden"}),", ",(0,l.jsx)(n.code,{children:"z-index"}),"\uc640 \uac19\uc740 \uc2a4\ud0c0\uc77c\uc774 \uc788\uc744 \ub54c \ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uc5d0 \uc758\uc874\uc801\uc774\uc9c0 \uc54a\uc544\uc57c\ud558\ub294 \uacbd\uc6b0 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-html",metastring:'title="html"',children:'
\n'})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",metastring:'title="tsx"',children:'function SampleComponent() {\n\n return (\n \n
Render component
\n \n );\n}\n'})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/components/GlobalPortal.tsx#L34",children:"packages/react/src/components/GlobalPortal.tsx:34"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},5392:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>d});var l=t(2784);const r={},s=l.createContext(r);function d(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[862],{9627:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>s,metadata:()=>i,toc:()=>o});var l=t(2322),r=t(5392);const s={id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},d=void 0,i={id:"react/modules/components",title:"Module: components",description:"Functions",source:"@site/docs/react/modules/components.md",sourceDirName:"react/modules",slug:"/react/modules/components",permalink:"/frontend-libraries/docs/react/modules/components",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"components",title:"Module: components",sidebar_label:"components",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Exports",permalink:"/frontend-libraries/docs/react/modules"},next:{title:"hooks",permalink:"/frontend-libraries/docs/react/modules/hooks"}},c={},o=[{value:"Functions",id:"functions",level:2},{value:"ClientOnly",id:"clientonly",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"DelayRenderComponent",id:"delayrendercomponent",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"GlobalPortal",id:"globalportal",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4}];function a(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"clientonly",children:"ClientOnly"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"ClientOnly"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Object"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["\u203a\xa0",(0,l.jsx)(n.code,{children:"children?"})]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"ReactNode"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ReactElement"})," | ",(0,l.jsx)(n.code,{children:"null"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\uc5ec mount\uac00 \ub41c \uacbd\uc6b0, Component\ub97c render\ud574\uc90d\ub2c8\ub2e4.\nmount\ub418\uc9c0 \uc54a\uc740 \uacbd\uc6b0\uc5d0\ub294 Component\ub97c render\ud574\uc8fc\uc9c0 \uc54a\uc2b5\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0\ub9cc \ud574\ub2f9 Component\ub97c \ubcf4\uc5ec\uc8fc\uace0 \uc2f6\uc744\ub54c \uc0ac\uc6a9\ud569\ub2c8\ub2e4.\n(SSR \ud658\uacbd\uc5d0\uc11c Hydration \uc624\ub958\ub85c \uc778\ud574\uc11c \uc5d0\ub7ec\uac00 \ubc1c\uc0dd\ud558\ub294 \ubb38\uc81c\ub97c \ud574\uacb0\ud569\ub2c8\ub2e4.)"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function ClintOnlyComponent() {\n return (\n \n
Render only client environment
\n \n );\n}\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/components/ClientOnly.tsx#L22",children:"packages/react/src/components/ClientOnly.tsx:22"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"delayrendercomponent",children:"DelayRenderComponent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"DelayRenderComponent"}),"(",(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"\xabdestructured\xbb"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"Element"})]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/components/DelayRenderComponent.tsx#L12",children:"packages/react/src/components/DelayRenderComponent.tsx:12"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"globalportal",children:"GlobalPortal"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"GlobalPortal"}),"(",(0,l.jsx)(n.code,{children:"elementId"}),"): ",(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"elementId"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"PropsWithChildren"}),"<",(0,l.jsx)(n.code,{children:"Props"}),">"]}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uac00 \uc544\ub2cc \ub2e4\ub978 DOM \ud2b8\ub9ac\uc758 elementId\uac12"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"ReactPortal"})]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc758 DOM \uc678\ubd80\uc5d0 \uc874\uc7ac\ud558\ub294 DOM \ub178\ub4dc\uc5d0 \ub80c\ub354\ub9c1 \ud560 \uc218 \uc788\uac8c \ud574\uc8fc\ub294\n",(0,l.jsx)(n.code,{children:"ReactDOM.createPortal"}),"\ub97c \uc774\uc6a9\ud574 \ucef4\ud3ec\ub10c\ud2b8\ub97c \ub80c\ub354\ub9c1\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\uacf5\ud1b5\uc801\uc778 UI(\ubaa8\ub2ec, \ud31d\uc5c5, \uc54c\ub9bc \ub4f1)\ub098 \ubd80\ubaa8 \ucef4\ud3ec\ub10c\ud2b8\uc5d0\n",(0,l.jsx)(n.code,{children:"overflow: hidden"}),", ",(0,l.jsx)(n.code,{children:"z-index"}),"\uc640 \uac19\uc740 \uc2a4\ud0c0\uc77c\uc774 \uc788\uc744 \ub54c \ubd80\ubaa8 \uc5d8\ub9ac\uba3c\ud2b8\uc5d0 \uc758\uc874\uc801\uc774\uc9c0 \uc54a\uc544\uc57c\ud558\ub294 \uacbd\uc6b0 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-html",metastring:'title="html"',children:'
\n'})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",metastring:'title="tsx"',children:'function SampleComponent() {\n\n return (\n \n
Render component
\n \n );\n}\n'})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/components/GlobalPortal.tsx#L34",children:"packages/react/src/components/GlobalPortal.tsx:34"})})]})}function h(e={}){const{wrapper:n}={...(0,r.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(a,{...e})}):a(e)}},5392:(e,n,t)=>{t.d(n,{Z:()=>i,a:()=>d});var l=t(2784);const r={},s=l.createContext(r);function d(e){const n=l.useContext(s);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:d(e.components),l.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/479ba500.c5697708.js b/assets/js/479ba500.78acc1c3.js similarity index 96% rename from assets/js/479ba500.c5697708.js rename to assets/js/479ba500.78acc1c3.js index 530ac357..4113cb1d 100644 --- a/assets/js/479ba500.c5697708.js +++ b/assets/js/479ba500.78acc1c3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[247],{8439:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>h});var r=l(2322),s=l(5392);const t={id:"modules",title:"@nf-team/core - v2.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"core/modules",title:"@nf-team/core - v2.1.0",description:"Functions",source:"@site/docs/core/modules.md",sourceDirName:"core",slug:"/core/modules",permalink:"/frontend-libraries/docs/core/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/core - v2.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/core/"},next:{title:"Readme",permalink:"/frontend-libraries/docs/react/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"checkEmpty",id:"checkempty",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"checkNumber",id:"checknumber",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"emptyAThenB",id:"emptyathenb",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"generateArrayOfNumber",id:"generatearrayofnumber",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isEmpty",id:"isempty",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"removeNullable",id:"removenullable",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"trueOrFalse",id:"trueorfalse",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function x(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(n.h3,{id:"checkempty",children:"checkEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L44",children:"utils.ts:44"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"checknumber",children:"checkNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkNumber"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"number"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"number"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L26",children:"utils.ts:26"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"emptyathenb",children:"emptyAThenB"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"emptyAThenB"}),"(",(0,r.jsx)(n.code,{children:"b"}),", ",(0,r.jsx)(n.code,{children:"a?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"b"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"a?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L34",children:"utils.ts:34"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"generatearrayofnumber",children:"generateArrayOfNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"generateArrayOfNumber"}),"(",(0,r.jsx)(n.code,{children:"length"}),"): ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"length"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"number"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L64",children:"utils.ts:64"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isempty",children:"isEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"isEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L52",children:"utils.ts:52"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removenullable",children:"removeNullable"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"removeNullable"}),"(",(0,r.jsx)(n.code,{children:"value?"}),", ",(0,r.jsx)(n.code,{children:"replacementValue?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\uccab \ubc88\uc9f8 \uc778\uc790 ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"undefined"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"replacementValue?"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\ub450 \ubc88\uc9f8 \uc778\uc790\uc5d0 \uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \uccab \ubc88\uc9f8 \uc778\uc790\uac00 ",(0,r.jsx)(n.code,{children:"null"})," \ub610\ub294 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uc778 \uacbd\uc6b0 \ub450\ubc88\uc9f8 \uc778\uc790\ub85c \ubb38\uc790\uc5f4 \ub300\uccb4"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Description"})})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"null"}),"\uc774\ub098 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \ube48\ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud558\uac70\ub098 \uc0c8\ub85c\uc6b4 \ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud569\ub2c8\ub2e4. (\uc624\ub85c\uc9c0 ",(0,r.jsx)(n.code,{children:"string"})," \ud0c0\uc785\uc73c\ub85c \ubc18\ud658)"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const value = undefined;\nconst result = removeNullable(value, 'newValue');\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"console.log(result); // 'newValue';\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L14",children:"utils.ts:14"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"trueorfalse",children:"trueOrFalse"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"trueOrFalse"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"boolean"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/core/src/utils.ts#L36",children:"utils.ts:36"})})]})}function a(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}},5392:(e,n,l)=>{l.d(n,{Z:()=>d,a:()=>i});var r=l(2784);const s={},t=r.createContext(s);function i(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[247],{8439:(e,n,l)=>{l.r(n),l.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>a,frontMatter:()=>t,metadata:()=>d,toc:()=>h});var r=l(2322),s=l(5392);const t={id:"modules",title:"@nf-team/core - v2.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"core/modules",title:"@nf-team/core - v2.1.0",description:"Functions",source:"@site/docs/core/modules.md",sourceDirName:"core",slug:"/core/modules",permalink:"/frontend-libraries/docs/core/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/core - v2.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/core/"},next:{title:"Readme",permalink:"/frontend-libraries/docs/react/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"checkEmpty",id:"checkempty",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"checkNumber",id:"checknumber",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"emptyAThenB",id:"emptyathenb",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"generateArrayOfNumber",id:"generatearrayofnumber",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"isEmpty",id:"isempty",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"removeNullable",id:"removenullable",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"trueOrFalse",id:"trueorfalse",level:3},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4}];function x(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,r.jsx)(n.h3,{id:"checkempty",children:"checkEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L44",children:"utils.ts:44"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"checknumber",children:"checkNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"checkNumber"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"number"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"number"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"number"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L26",children:"utils.ts:26"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"emptyathenb",children:"emptyAThenB"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"emptyAThenB"}),"(",(0,r.jsx)(n.code,{children:"b"}),", ",(0,r.jsx)(n.code,{children:"a?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"b"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"a?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L34",children:"utils.ts:34"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"generatearrayofnumber",children:"generateArrayOfNumber"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"generateArrayOfNumber"}),"(",(0,r.jsx)(n.code,{children:"length"}),"): ",(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"length"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"number"})})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"number"}),"[]"]}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L64",children:"utils.ts:64"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"isempty",children:"isEmpty"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"isEmpty"}),"<",(0,r.jsx)(n.code,{children:"T"}),">(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,r.jsx)(n.tbody,{children:(0,r.jsx)(n.tr,{children:(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"T"}),"[]"]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L52",children:"utils.ts:52"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"removenullable",children:"removeNullable"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"removeNullable"}),"(",(0,r.jsx)(n.code,{children:"value?"}),", ",(0,r.jsx)(n.code,{children:"replacementValue?"}),"): ",(0,r.jsx)(n.code,{children:"string"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})]}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\uccab \ubc88\uc9f8 \uc778\uc790 ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"undefined"})]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"replacementValue?"})}),(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"string"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:["\ub450 \ubc88\uc9f8 \uc778\uc790\uc5d0 \uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \uccab \ubc88\uc9f8 \uc778\uc790\uac00 ",(0,r.jsx)(n.code,{children:"null"})," \ub610\ub294 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uc778 \uacbd\uc6b0 \ub450\ubc88\uc9f8 \uc778\uc790\ub85c \ubb38\uc790\uc5f4 \ub300\uccb4"]})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"string"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Description"})})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"null"}),"\uc774\ub098 ",(0,r.jsx)(n.code,{children:"undefined"}),"\uac12\uc774 \uc874\uc7ac\ud558\ub294 \uacbd\uc6b0 \ube48\ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud558\uac70\ub098 \uc0c8\ub85c\uc6b4 \ubb38\uc790\uc5f4\ub85c \ub300\uccb4\ud569\ub2c8\ub2e4. (\uc624\ub85c\uc9c0 ",(0,r.jsx)(n.code,{children:"string"})," \ud0c0\uc785\uc73c\ub85c \ubc18\ud658)"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"const value = undefined;\nconst result = removeNullable(value, 'newValue');\n"})}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:(0,r.jsx)(n.code,{children:"Example"})})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-ts",children:"console.log(result); // 'newValue';\n"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L14",children:"utils.ts:14"})}),"\n",(0,r.jsx)(n.hr,{}),"\n",(0,r.jsx)(n.h3,{id:"trueorfalse",children:"trueOrFalse"}),"\n",(0,r.jsxs)(n.p,{children:["\u25b8 ",(0,r.jsx)(n.strong,{children:"trueOrFalse"}),"(",(0,r.jsx)(n.code,{children:"value?"}),"): ",(0,r.jsx)(n.code,{children:"boolean"})]}),"\n",(0,r.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,r.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{style:{textAlign:"left"},children:(0,r.jsx)(n.code,{children:"value?"})}),(0,r.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,r.jsx)(n.code,{children:"null"})," | ",(0,r.jsx)(n.code,{children:"string"})," | ",(0,r.jsx)(n.code,{children:"number"})," | ",(0,r.jsx)(n.code,{children:"boolean"})]})]})})]}),"\n",(0,r.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.code,{children:"boolean"})}),"\n",(0,r.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/core/src/utils.ts#L36",children:"utils.ts:36"})})]})}function a(e={}){const{wrapper:n}={...(0,s.a)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(x,{...e})}):x(e)}},5392:(e,n,l)=>{l.d(n,{Z:()=>d,a:()=>i});var r=l(2784);const s={},t=r.createContext(s);function i(e){const n=r.useContext(t);return r.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:i(e.components),r.createElement(t.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/68d9404b.7e0f10a3.js b/assets/js/68d9404b.1e63ad03.js similarity index 98% rename from assets/js/68d9404b.7e0f10a3.js rename to assets/js/68d9404b.1e63ad03.js index 780ba7d2..5d3c3553 100644 --- a/assets/js/68d9404b.7e0f10a3.js +++ b/assets/js/68d9404b.1e63ad03.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[257],{3725:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>o,frontMatter:()=>t,metadata:()=>l,toc:()=>h});var i=n(2322),s=n(5392);const t={id:"FetchError",title:"Class: FetchError",sidebar_label:"FetchError",sidebar_position:0,custom_edit_url:null},d=void 0,l={id:"fetch/classes/FetchError",title:"Class: FetchError",description:"Hierarchy",source:"@site/docs/fetch/classes/FetchError.md",sourceDirName:"fetch/classes",slug:"/fetch/classes/FetchError",permalink:"/frontend-libraries/docs/fetch/classes/FetchError",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FetchError",title:"Class: FetchError",sidebar_label:"FetchError",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Exports",permalink:"/frontend-libraries/docs/fetch/modules"},next:{title:"FetchApiRequest",permalink:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest"}},c={},h=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4}];function a(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsxs)(r.li,{children:["\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"Error"})}),"\n",(0,i.jsxs)(r.p,{children:["\u21b3 ",(0,i.jsx)(r.strong,{children:(0,i.jsx)(r.code,{children:"FetchError"})})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(r.h3,{id:"constructor",children:"constructor"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"new FetchError"}),"(",(0,i.jsx)(r.code,{children:"status"}),", ",(0,i.jsx)(r.code,{children:"message"}),"): ",(0,i.jsx)(r.a,{href:"/frontend-libraries/docs/fetch/classes/FetchError",children:(0,i.jsx)(r.code,{children:"FetchError"})})]}),"\n",(0,i.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"status"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"number"})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"message"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"string"})})]})]})]}),"\n",(0,i.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/frontend-libraries/docs/fetch/classes/FetchError",children:(0,i.jsx)(r.code,{children:"FetchError"})})}),"\n",(0,i.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,i.jsx)(r.p,{children:"Error.constructor"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L6",children:"packages/fetch/src/fetch.ts:6"})}),"\n",(0,i.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"message"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.message"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1068"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"name"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.name"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1067"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"stack",children:"stack"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.code,{children:"Optional"})," ",(0,i.jsx)(r.strong,{children:"stack"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.stack"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1069"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"status"}),": ",(0,i.jsx)(r.code,{children:"number"})]}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L6",children:"packages/fetch/src/fetch.ts:6"})}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace"}),"\n",(0,i.jsxs)(r.p,{children:["\u25aa ",(0,i.jsx)(r.code,{children:"Static"})," ",(0,i.jsx)(r.code,{children:"Optional"})," ",(0,i.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,i.jsx)(r.code,{children:"err"}),": ",(0,i.jsx)(r.code,{children:"Error"}),", ",(0,i.jsx)(r.code,{children:"stackTraces"}),": ",(0,i.jsx)(r.code,{children:"CallSite"}),"[]) => ",(0,i.jsx)(r.code,{children:"any"})]}),"\n",(0,i.jsx)(r.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,i.jsxs)(r.p,{children:["\u25b8 (",(0,i.jsx)(r.code,{children:"err"}),", ",(0,i.jsx)(r.code,{children:"stackTraces"}),"): ",(0,i.jsx)(r.code,{children:"any"})]}),"\n",(0,i.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,i.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"err"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"Error"})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"stackTraces"})}),(0,i.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,i.jsx)(r.code,{children:"CallSite"}),"[]"]})]})]})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"any"})}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.strong,{children:(0,i.jsx)(r.code,{children:"See"})})}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.prepareStackTrace"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/@types/node/globals.d.ts:11"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,i.jsxs)(r.p,{children:["\u25aa ",(0,i.jsx)(r.code,{children:"Static"})," ",(0,i.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,i.jsx)(r.code,{children:"number"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.stackTraceLimit"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/@types/node/globals.d.ts:13"}),"\n",(0,i.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace"}),"\n",(0,i.jsxs)(r.p,{children:["\u25b8 ",(0,i.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,i.jsx)(r.code,{children:"targetObject"}),", ",(0,i.jsx)(r.code,{children:"constructorOpt?"}),"): ",(0,i.jsx)(r.code,{children:"void"})]}),"\n",(0,i.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,i.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"targetObject"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"object"})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"constructorOpt?"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"Function"})})]})]})]}),"\n",(0,i.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"void"})}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.captureStackTrace"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/@types/node/globals.d.ts:4"})]})}function o(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},5392:(e,r,n)=>{n.d(r,{Z:()=>l,a:()=>d});var i=n(2784);const s={},t=i.createContext(s);function d(e){const r=i.useContext(t);return i.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(s):e.components||s:d(e.components),i.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[257],{3725:(e,r,n)=>{n.r(r),n.d(r,{assets:()=>c,contentTitle:()=>d,default:()=>o,frontMatter:()=>t,metadata:()=>l,toc:()=>h});var i=n(2322),s=n(5392);const t={id:"FetchError",title:"Class: FetchError",sidebar_label:"FetchError",sidebar_position:0,custom_edit_url:null},d=void 0,l={id:"fetch/classes/FetchError",title:"Class: FetchError",description:"Hierarchy",source:"@site/docs/fetch/classes/FetchError.md",sourceDirName:"fetch/classes",slug:"/fetch/classes/FetchError",permalink:"/frontend-libraries/docs/fetch/classes/FetchError",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FetchError",title:"Class: FetchError",sidebar_label:"FetchError",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Exports",permalink:"/frontend-libraries/docs/fetch/modules"},next:{title:"FetchApiRequest",permalink:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest"}},c={},h=[{value:"Hierarchy",id:"hierarchy",level:2},{value:"Constructors",id:"constructors",level:2},{value:"constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"Properties",id:"properties",level:2},{value:"message",id:"message",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"name",id:"name",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"stack",id:"stack",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"status",id:"status",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"prepareStackTrace",id:"preparestacktrace",level:3},{value:"Type declaration",id:"type-declaration",level:4},{value:"Parameters",id:"parameters-1",level:5},{value:"Returns",id:"returns-1",level:5},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"stackTraceLimit",id:"stacktracelimit",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"Methods",id:"methods",level:2},{value:"captureStackTrace",id:"capturestacktrace",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"Defined in",id:"defined-in-7",level:4}];function a(e){const r={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",li:"li",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(r.h2,{id:"hierarchy",children:"Hierarchy"}),"\n",(0,i.jsxs)(r.ul,{children:["\n",(0,i.jsxs)(r.li,{children:["\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"Error"})}),"\n",(0,i.jsxs)(r.p,{children:["\u21b3 ",(0,i.jsx)(r.strong,{children:(0,i.jsx)(r.code,{children:"FetchError"})})]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,i.jsx)(r.h3,{id:"constructor",children:"constructor"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"new FetchError"}),"(",(0,i.jsx)(r.code,{children:"status"}),", ",(0,i.jsx)(r.code,{children:"message"}),"): ",(0,i.jsx)(r.a,{href:"/frontend-libraries/docs/fetch/classes/FetchError",children:(0,i.jsx)(r.code,{children:"FetchError"})})]}),"\n",(0,i.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"status"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"number"})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"message"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"string"})})]})]})]}),"\n",(0,i.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"/frontend-libraries/docs/fetch/classes/FetchError",children:(0,i.jsx)(r.code,{children:"FetchError"})})}),"\n",(0,i.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,i.jsx)(r.p,{children:"Error.constructor"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L6",children:"packages/fetch/src/fetch.ts:6"})}),"\n",(0,i.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(r.h3,{id:"message",children:"message"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"message"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.message"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1068"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"name",children:"name"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"name"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.name"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1067"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"stack",children:"stack"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.code,{children:"Optional"})," ",(0,i.jsx)(r.strong,{children:"stack"}),": ",(0,i.jsx)(r.code,{children:"string"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.stack"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/typescript/lib/lib.es5.d.ts:1069"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"status",children:"status"}),"\n",(0,i.jsxs)(r.p,{children:["\u2022 ",(0,i.jsx)(r.strong,{children:"status"}),": ",(0,i.jsx)(r.code,{children:"number"})]}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L6",children:"packages/fetch/src/fetch.ts:6"})}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"preparestacktrace",children:"prepareStackTrace"}),"\n",(0,i.jsxs)(r.p,{children:["\u25aa ",(0,i.jsx)(r.code,{children:"Static"})," ",(0,i.jsx)(r.code,{children:"Optional"})," ",(0,i.jsx)(r.strong,{children:"prepareStackTrace"}),": (",(0,i.jsx)(r.code,{children:"err"}),": ",(0,i.jsx)(r.code,{children:"Error"}),", ",(0,i.jsx)(r.code,{children:"stackTraces"}),": ",(0,i.jsx)(r.code,{children:"CallSite"}),"[]) => ",(0,i.jsx)(r.code,{children:"any"})]}),"\n",(0,i.jsx)(r.h4,{id:"type-declaration",children:"Type declaration"}),"\n",(0,i.jsxs)(r.p,{children:["\u25b8 (",(0,i.jsx)(r.code,{children:"err"}),", ",(0,i.jsx)(r.code,{children:"stackTraces"}),"): ",(0,i.jsx)(r.code,{children:"any"})]}),"\n",(0,i.jsx)(r.p,{children:"Optional override for formatting stack traces"}),"\n",(0,i.jsx)(r.h5,{id:"parameters-1",children:"Parameters"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"err"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"Error"})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"stackTraces"})}),(0,i.jsxs)(r.td,{style:{textAlign:"left"},children:[(0,i.jsx)(r.code,{children:"CallSite"}),"[]"]})]})]})]}),"\n",(0,i.jsx)(r.h5,{id:"returns-1",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"any"})}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.strong,{children:(0,i.jsx)(r.code,{children:"See"})})}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.a,{href:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces",children:"https://v8.dev/docs/stack-trace-api#customizing-stack-traces"})}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.prepareStackTrace"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/@types/node/globals.d.ts:11"}),"\n",(0,i.jsx)(r.hr,{}),"\n",(0,i.jsx)(r.h3,{id:"stacktracelimit",children:"stackTraceLimit"}),"\n",(0,i.jsxs)(r.p,{children:["\u25aa ",(0,i.jsx)(r.code,{children:"Static"})," ",(0,i.jsx)(r.strong,{children:"stackTraceLimit"}),": ",(0,i.jsx)(r.code,{children:"number"})]}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.stackTraceLimit"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/@types/node/globals.d.ts:13"}),"\n",(0,i.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,i.jsx)(r.h3,{id:"capturestacktrace",children:"captureStackTrace"}),"\n",(0,i.jsxs)(r.p,{children:["\u25b8 ",(0,i.jsx)(r.strong,{children:"captureStackTrace"}),"(",(0,i.jsx)(r.code,{children:"targetObject"}),", ",(0,i.jsx)(r.code,{children:"constructorOpt?"}),"): ",(0,i.jsx)(r.code,{children:"void"})]}),"\n",(0,i.jsx)(r.p,{children:"Create .stack property on a target object"}),"\n",(0,i.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,i.jsxs)(r.table,{children:[(0,i.jsx)(r.thead,{children:(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(r.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsxs)(r.tbody,{children:[(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"targetObject"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"object"})})]}),(0,i.jsxs)(r.tr,{children:[(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"constructorOpt?"})}),(0,i.jsx)(r.td,{style:{textAlign:"left"},children:(0,i.jsx)(r.code,{children:"Function"})})]})]})]}),"\n",(0,i.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,i.jsx)(r.p,{children:(0,i.jsx)(r.code,{children:"void"})}),"\n",(0,i.jsx)(r.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,i.jsx)(r.p,{children:"Error.captureStackTrace"}),"\n",(0,i.jsx)(r.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,i.jsx)(r.p,{children:"node_modules/@types/node/globals.d.ts:4"})]})}function o(e={}){const{wrapper:r}={...(0,s.a)(),...e.components};return r?(0,i.jsx)(r,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},5392:(e,r,n)=>{n.d(r,{Z:()=>l,a:()=>d});var i=n(2784);const s={},t=i.createContext(s);function d(e){const r=i.useContext(t);return i.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(s):e.components||s:d(e.components),i.createElement(t.Provider,{value:r},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/6acc1546.a0a3cc53.js b/assets/js/6acc1546.fca4563d.js similarity index 96% rename from assets/js/6acc1546.a0a3cc53.js rename to assets/js/6acc1546.fca4563d.js index aacb88af..cb9ad02e 100644 --- a/assets/js/6acc1546.a0a3cc53.js +++ b/assets/js/6acc1546.fca4563d.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[767],{186:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>d,metadata:()=>r,toc:()=>h});var l=s(2322),t=s(5392);const d={id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},i=void 0,r={id:"react/modules/hooks",title:"Module: hooks",description:"Functions",source:"@site/docs/react/modules/hooks.md",sourceDirName:"react/modules",slug:"/react/modules/hooks",permalink:"/frontend-libraries/docs/react/modules/hooks",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"components",permalink:"/frontend-libraries/docs/react/modules/components"},next:{title:"@nf-team/eslint-config",permalink:"/frontend-libraries/docs/eslint-config/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"useActionKeyEvent",id:"useactionkeyevent",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"useBoolean",id:"useboolean",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useDebounce",id:"usedebounce",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useEffectOnce",id:"useeffectonce",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useGeolocation",id:"usegeolocation",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useIsFirstRender",id:"useisfirstrender",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useIsMounted",id:"useismounted",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useIsomorphicLayoutEffect",id:"useisomorphiclayouteffect",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useLessThenScrollY",id:"uselessthenscrolly",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useResizeViewportHeight",id:"useresizeviewportheight",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useThrottleCallback",id:"usethrottlecallback",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-10",level:4},{value:"useTimeout",id:"usetimeout",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useUnmount",id:"useunmount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useUpdateEffect",id:"useupdateeffect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-13",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"useactionkeyevent",children:"useActionKeyEvent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"targetKeys"}),", ",(0,l.jsx)(n.code,{children:"callback?"}),"): ",(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Element"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetKeys"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"string"}),"[]"]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback?"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,l.jsx)(n.code,{children:"event"}),": ",(0,l.jsx)(n.code,{children:"KeyboardEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),">, ...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useActionKeyEvent.ts#L6",children:"packages/react/src/hooks/useActionKeyEvent.ts:6"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useboolean",children:"useBoolean"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useBoolean"}),"(",(0,l.jsx)(n.code,{children:"initialValue?"}),"): [",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"initialValue"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"boolean"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"false"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ucd08\uae30\uac12\uc744 \uc138\ud305"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"boolean"})," \ud0c0\uc785\uc73c\ub85c\ub9cc \ubc18\ud658\ud558\ub294 ",(0,l.jsx)(n.code,{children:"useState"}),"\ub97c \uc27d\uac8c \uc0ac\uc6a9\ud560 \uc218 \uc788\ub294 hook \uc785\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const [isOpen, openModal, closeModal, toggleModal] = useBoolean();\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useBoolean.ts#L13",children:"packages/react/src/hooks/useBoolean.ts:13"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usedebounce",children:"useDebounce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useDebounce"}),"<",(0,l.jsx)(n.code,{children:"T"}),">(",(0,l.jsx)(n.code,{children:"value"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"T"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(n.tbody,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"value"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useDebounce.ts#L3",children:"packages/react/src/hooks/useDebounce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useeffectonce",children:"useEffectOnce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useEffectOnce"}),"(",(0,l.jsx)(n.code,{children:"effect"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useEffectOnce.ts#L3",children:"packages/react/src/hooks/useEffectOnce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usegeolocation",children:"useGeolocation"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useGeolocation"}),"(): [",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useGeolocation.ts#L15",children:"packages/react/src/hooks/useGeolocation.ts:15"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisfirstrender",children:"useIsFirstRender"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsFirstRender"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useIsFirstRender.ts#L3",children:"packages/react/src/hooks/useIsFirstRender.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useismounted",children:"useIsMounted"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsMounted"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\ub294 hook \uc785\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0 \uc5b4\ub5a4 \ub3d9\uc791\uc744 \uc2e4\ud589\ud558\uae30 \uc704\ud574\uc11c \uc0ac\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const isMounted = useIsMounted();\n\nuseEffect(() => {\n if (isMounted) {\n return;\n }\n}, [isMounted]);\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useIsMounted.ts#L18",children:"packages/react/src/hooks/useIsMounted.ts:18"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisomorphiclayouteffect",children:"useIsomorphicLayoutEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsomorphicLayoutEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.p,{children:"Accepts a function that contains imperative, possibly effectful code."}),"\n",(0,l.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"Imperative function that can return a cleanup function"})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"If present, effect will only activate if the values in the list change."})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Version"})})}),"\n",(0,l.jsx)(n.p,{children:"16.8.0"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"See"})})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://react.dev/reference/react/useEffect",children:"https://react.dev/reference/react/useEffect"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:"node_modules/@types/react/index.d.ts:2031"}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"uselessthenscrolly",children:"useLessThenScrollY"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useLessThenScrollY"}),"(",(0,l.jsx)(n.code,{children:"targetScrollY?"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetScrollY"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"0"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"200"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useLessThenScrollY.ts#L5",children:"packages/react/src/hooks/useLessThenScrollY.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useresizeviewportheight",children:"useResizeViewportHeight"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useResizeViewportHeight"}),"(): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\uc2a4\ud06c\ub864\uc744 \ud3ec\ud568\ud55c window\uc758 \ub192\uc774\ub97c \uac00\uc838\uc640 window \ud06c\uae30\ub97c resize\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\ubaa8\ubc14\uc77c \ud658\uacbd\uc758 \uc6f9\ubdf0\uc5d0\uc11c \ub514\ubc14\uc774\uc2a4 \ubc0f \ube0c\ub77c\uc6b0\uc800 \ud658\uacbd\uc5d0 \ub530\ub77c \ud06c\uae30\uac00 \ub2ec\ub77c\uc838 \ubd88\ud544\uc694\ud55c \uc2a4\ud06c\ub864\uc774 \uc0dd\uae38 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc774\ub54c \uc774 hook\uc744 \uc0ac\uc6a9\ud558\uba74 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function SampleComponent() {\n useResizeViewportHeight();\n\n return
sample text
\n}\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useResizeViewportHeight.ts#L17",children:"packages/react/src/hooks/useResizeViewportHeight.ts:17"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usethrottlecallback",children:"useThrottleCallback"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useThrottleCallback"}),"<",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"dependencyList"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): (...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"dependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"fn"})}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 (",(0,l.jsx)(n.code,{children:"...args"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"...args"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})})]})})]}),"\n",(0,l.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useThrottleCallback.ts#L3",children:"packages/react/src/hooks/useThrottleCallback.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usetimeout",children:"useTimeout"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useTimeout"}),"(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"number"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useTimeout.ts#L5",children:"packages/react/src/hooks/useTimeout.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useunmount",children:"useUnmount"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUnmount"}),"(",(0,l.jsx)(n.code,{children:"fn"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"fn"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useUnmount.ts#L5",children:"packages/react/src/hooks/useUnmount.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useupdateeffect",children:"useUpdateEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUpdateEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/react/src/hooks/useUpdateEffect.ts#L5",children:"packages/react/src/hooks/useUpdateEffect.ts:5"})})]})}function x(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},5392:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>i});var l=s(2784);const t={},d=l.createContext(t);function i(e){const n=l.useContext(d);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),l.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[767],{186:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>c,contentTitle:()=>i,default:()=>x,frontMatter:()=>d,metadata:()=>r,toc:()=>h});var l=s(2322),t=s(5392);const d={id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},i=void 0,r={id:"react/modules/hooks",title:"Module: hooks",description:"Functions",source:"@site/docs/react/modules/hooks.md",sourceDirName:"react/modules",slug:"/react/modules/hooks",permalink:"/frontend-libraries/docs/react/modules/hooks",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"hooks",title:"Module: hooks",sidebar_label:"hooks",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"components",permalink:"/frontend-libraries/docs/react/modules/components"},next:{title:"@nf-team/eslint-config",permalink:"/frontend-libraries/docs/eslint-config/"}},c={},h=[{value:"Functions",id:"functions",level:2},{value:"useActionKeyEvent",id:"useactionkeyevent",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"useBoolean",id:"useboolean",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"useDebounce",id:"usedebounce",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"useEffectOnce",id:"useeffectonce",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"useGeolocation",id:"usegeolocation",level:3},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"useIsFirstRender",id:"useisfirstrender",level:3},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"useIsMounted",id:"useismounted",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"useIsomorphicLayoutEffect",id:"useisomorphiclayouteffect",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-7",level:4},{value:"Defined in",id:"defined-in-7",level:4},{value:"useLessThenScrollY",id:"uselessthenscrolly",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-8",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"useResizeViewportHeight",id:"useresizeviewportheight",level:3},{value:"Returns",id:"returns-9",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"useThrottleCallback",id:"usethrottlecallback",level:3},{value:"Type parameters",id:"type-parameters-2",level:4},{value:"Parameters",id:"parameters-6",level:4},{value:"Returns",id:"returns-10",level:4},{value:"Parameters",id:"parameters-7",level:5},{value:"Returns",id:"returns-11",level:5},{value:"Defined in",id:"defined-in-10",level:4},{value:"useTimeout",id:"usetimeout",level:3},{value:"Parameters",id:"parameters-8",level:4},{value:"Returns",id:"returns-12",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"useUnmount",id:"useunmount",level:3},{value:"Parameters",id:"parameters-9",level:4},{value:"Returns",id:"returns-13",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useUpdateEffect",id:"useupdateeffect",level:3},{value:"Parameters",id:"parameters-10",level:4},{value:"Returns",id:"returns-14",level:4},{value:"Defined in",id:"defined-in-13",level:4}];function o(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",hr:"hr",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.a)(),...e.components};return(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)(n.h2,{id:"functions",children:"Functions"}),"\n",(0,l.jsx)(n.h3,{id:"useactionkeyevent",children:"useActionKeyEvent"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"targetKeys"}),", ",(0,l.jsx)(n.code,{children:"callback?"}),"): ",(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"Element"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetKeys"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"string"})," | ",(0,l.jsx)(n.code,{children:"string"}),"[]"]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback?"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(",(0,l.jsx)(n.code,{children:"event"}),": ",(0,l.jsx)(n.code,{children:"KeyboardEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),">, ...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"ActionKeyEvent"}),"<",(0,l.jsx)(n.code,{children:"T"}),", ",(0,l.jsx)(n.code,{children:"U"}),">"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useActionKeyEvent.ts#L6",children:"packages/react/src/hooks/useActionKeyEvent.ts:6"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useboolean",children:"useBoolean"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useBoolean"}),"(",(0,l.jsx)(n.code,{children:"initialValue?"}),"): [",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"initialValue"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"boolean"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"false"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"\ucd08\uae30\uac12\uc744 \uc138\ud305"})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-1",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"boolean"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),", (",(0,l.jsx)(n.code,{children:"nextValue?"}),": ",(0,l.jsx)(n.code,{children:"boolean"}),") => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:[(0,l.jsx)(n.code,{children:"boolean"})," \ud0c0\uc785\uc73c\ub85c\ub9cc \ubc18\ud658\ud558\ub294 ",(0,l.jsx)(n.code,{children:"useState"}),"\ub97c \uc27d\uac8c \uc0ac\uc6a9\ud560 \uc218 \uc788\ub294 hook \uc785\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const [isOpen, openModal, closeModal, toggleModal] = useBoolean();\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useBoolean.ts#L13",children:"packages/react/src/hooks/useBoolean.ts:13"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usedebounce",children:"useDebounce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useDebounce"}),"<",(0,l.jsx)(n.code,{children:"T"}),">(",(0,l.jsx)(n.code,{children:"value"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"T"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"})})}),(0,l.jsx)(n.tbody,{children:(0,l.jsx)(n.tr,{children:(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"value"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"T"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-2",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"T"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useDebounce.ts#L3",children:"packages/react/src/hooks/useDebounce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useeffectonce",children:"useEffectOnce"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useEffectOnce"}),"(",(0,l.jsx)(n.code,{children:"effect"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-3",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useEffectOnce.ts#L3",children:"packages/react/src/hooks/useEffectOnce.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usegeolocation",children:"useGeolocation"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useGeolocation"}),"(): [",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"returns-4",children:"Returns"}),"\n",(0,l.jsxs)(n.p,{children:["[",(0,l.jsx)(n.code,{children:"GeoLocation"}),", () => ",(0,l.jsx)(n.code,{children:"void"}),"]"]}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useGeolocation.ts#L15",children:"packages/react/src/hooks/useGeolocation.ts:15"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisfirstrender",children:"useIsFirstRender"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsFirstRender"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-5",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useIsFirstRender.ts#L3",children:"packages/react/src/hooks/useIsFirstRender.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useismounted",children:"useIsMounted"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsMounted"}),"(): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-6",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["Component\uc758 mount \uc5ec\ubd80\ub97c \ud655\uc778\ud558\ub294 hook \uc785\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\nSSR \ud658\uacbd\uc5d0\uc11c \uc2e4\uc81c\ub85c \ucef4\ud3ec\ub10c\ud2b8\uac00 \ube0c\ub77c\uc6b0\uc800\uc5d0\uc11c mount \ub41c \uc774\ud6c4\uc5d0 \uc5b4\ub5a4 \ub3d9\uc791\uc744 \uc2e4\ud589\ud558\uae30 \uc704\ud574\uc11c \uc0ac\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-ts",children:"const isMounted = useIsMounted();\n\nuseEffect(() => {\n if (isMounted) {\n return;\n }\n}, [isMounted]);\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useIsMounted.ts#L18",children:"packages/react/src/hooks/useIsMounted.ts:18"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useisomorphiclayouteffect",children:"useIsomorphicLayoutEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useIsomorphicLayoutEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.p,{children:"Accepts a function that contains imperative, possibly effectful code."}),"\n",(0,l.jsx)(n.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"Imperative function that can return a cleanup function"})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:"If present, effect will only activate if the values in the list change."})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-7",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Version"})})}),"\n",(0,l.jsx)(n.p,{children:"16.8.0"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"See"})})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://react.dev/reference/react/useEffect",children:"https://react.dev/reference/react/useEffect"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:"node_modules/@types/react/index.d.ts:2031"}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"uselessthenscrolly",children:"useLessThenScrollY"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useLessThenScrollY"}),"(",(0,l.jsx)(n.code,{children:"targetScrollY?"}),", ",(0,l.jsx)(n.code,{children:"delay?"}),"): ",(0,l.jsx)(n.code,{children:"boolean"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Default value"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"targetScrollY"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"0"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"200"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-8",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"boolean"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useLessThenScrollY.ts#L5",children:"packages/react/src/hooks/useLessThenScrollY.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useresizeviewportheight",children:"useResizeViewportHeight"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useResizeViewportHeight"}),"(): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-9",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Description"})})}),"\n",(0,l.jsxs)(n.p,{children:["\uc2a4\ud06c\ub864\uc744 \ud3ec\ud568\ud55c window\uc758 \ub192\uc774\ub97c \uac00\uc838\uc640 window \ud06c\uae30\ub97c resize\ud574\uc90d\ub2c8\ub2e4. ",(0,l.jsx)("br",{}),"\n\ubaa8\ubc14\uc77c \ud658\uacbd\uc758 \uc6f9\ubdf0\uc5d0\uc11c \ub514\ubc14\uc774\uc2a4 \ubc0f \ube0c\ub77c\uc6b0\uc800 \ud658\uacbd\uc5d0 \ub530\ub77c \ud06c\uae30\uac00 \ub2ec\ub77c\uc838 \ubd88\ud544\uc694\ud55c \uc2a4\ud06c\ub864\uc774 \uc0dd\uae38 \uc218 \uc788\uc2b5\ub2c8\ub2e4. \uc774\ub54c \uc774 hook\uc744 \uc0ac\uc6a9\ud558\uba74 \uc720\uc6a9\ud569\ub2c8\ub2e4."]}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.strong,{children:(0,l.jsx)(n.code,{children:"Example"})})}),"\n",(0,l.jsx)(n.pre,{children:(0,l.jsx)(n.code,{className:"language-tsx",children:"function SampleComponent() {\n useResizeViewportHeight();\n\n return
sample text
\n}\n\n"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useResizeViewportHeight.ts#L17",children:"packages/react/src/hooks/useResizeViewportHeight.ts:17"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usethrottlecallback",children:"useThrottleCallback"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useThrottleCallback"}),"<",(0,l.jsx)(n.code,{children:"U"}),">(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"dependencyList"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): (...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"type-parameters-2",children:"Type parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["extends ",(0,l.jsx)(n.code,{children:"unknown"}),"[] = []"]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-6",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["(...",(0,l.jsx)(n.code,{children:"args"}),": ",(0,l.jsx)(n.code,{children:"U"}),") => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"dependencyList"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"number"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-10",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"fn"})}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 (",(0,l.jsx)(n.code,{children:"...args"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h5,{id:"parameters-7",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"...args"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"U"})})]})})]}),"\n",(0,l.jsx)(n.h5,{id:"returns-11",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useThrottleCallback.ts#L3",children:"packages/react/src/hooks/useThrottleCallback.ts:3"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"usetimeout",children:"useTimeout"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useTimeout"}),"(",(0,l.jsx)(n.code,{children:"callback"}),", ",(0,l.jsx)(n.code,{children:"delay"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-8",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"callback"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"delay"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:[(0,l.jsx)(n.code,{children:"null"})," | ",(0,l.jsx)(n.code,{children:"number"})]})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-12",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useTimeout.ts#L5",children:"packages/react/src/hooks/useTimeout.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useunmount",children:"useUnmount"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUnmount"}),"(",(0,l.jsx)(n.code,{children:"fn"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-9",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsx)(n.tbody,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"fn"})}),(0,l.jsxs)(n.td,{style:{textAlign:"left"},children:["() => ",(0,l.jsx)(n.code,{children:"void"})]})]})})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-13",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useUnmount.ts#L5",children:"packages/react/src/hooks/useUnmount.ts:5"})}),"\n",(0,l.jsx)(n.hr,{}),"\n",(0,l.jsx)(n.h3,{id:"useupdateeffect",children:"useUpdateEffect"}),"\n",(0,l.jsxs)(n.p,{children:["\u25b8 ",(0,l.jsx)(n.strong,{children:"useUpdateEffect"}),"(",(0,l.jsx)(n.code,{children:"effect"}),", ",(0,l.jsx)(n.code,{children:"deps?"}),"): ",(0,l.jsx)(n.code,{children:"void"})]}),"\n",(0,l.jsx)(n.h4,{id:"parameters-10",children:"Parameters"}),"\n",(0,l.jsxs)(n.table,{children:[(0,l.jsx)(n.thead,{children:(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Name"}),(0,l.jsx)(n.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,l.jsxs)(n.tbody,{children:[(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"effect"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"EffectCallback"})})]}),(0,l.jsxs)(n.tr,{children:[(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"deps?"})}),(0,l.jsx)(n.td,{style:{textAlign:"left"},children:(0,l.jsx)(n.code,{children:"DependencyList"})})]})]})]}),"\n",(0,l.jsx)(n.h4,{id:"returns-14",children:"Returns"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.code,{children:"void"})}),"\n",(0,l.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,l.jsx)(n.p,{children:(0,l.jsx)(n.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/react/src/hooks/useUpdateEffect.ts#L5",children:"packages/react/src/hooks/useUpdateEffect.ts:5"})})]})}function x(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,l.jsx)(n,{...e,children:(0,l.jsx)(o,{...e})}):o(e)}},5392:(e,n,s)=>{s.d(n,{Z:()=>r,a:()=>i});var l=s(2784);const t={},d=l.createContext(t);function i(e){const n=l.useContext(d);return l.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:i(e.components),l.createElement(d.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/a132c40c.01633b05.js b/assets/js/a132c40c.0ac0cab3.js similarity index 96% rename from assets/js/a132c40c.01633b05.js rename to assets/js/a132c40c.0ac0cab3.js index 0370e58c..93234d9d 100644 --- a/assets/js/a132c40c.01633b05.js +++ b/assets/js/a132c40c.0ac0cab3.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49],{3695:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>a});var n=s(2322),r=s(5392);const l={id:"modules",title:"@nf-team/storage - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"storage/modules",title:"@nf-team/storage - v1.1.0",description:"Functions",source:"@site/docs/storage/modules.md",sourceDirName:"storage",slug:"/storage/modules",permalink:"/frontend-libraries/docs/storage/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/storage - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/storage/"},next:{title:"Readme",permalink:"/frontend-libraries/docs/fetch/"}},c={},a=[{value:"Functions",id:"functions",level:2},{value:"getLocalStorageItem",id:"getlocalstorageitem",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"getSessionStorageItem",id:"getsessionstorageitem",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"removeLocalStorageItem",id:"removelocalstorageitem",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"removeSessionStorageItem",id:"removesessionstorageitem",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"setLocalStorageItem",id:"setlocalstorageitem",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"setSessionStorageItem",id:"setsessionstorageitem",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,n.jsx)(t.h3,{id:"getlocalstorageitem",children:"getLocalStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"getLocalStorageItem"}),"<",(0,n.jsx)(t.code,{children:"T"}),">(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,n.jsx)(t.tbody,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/storage/src/localStorage.ts#L5",children:"localStorage.ts:5"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"getsessionstorageitem",children:"getSessionStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"getSessionStorageItem"}),"<",(0,n.jsx)(t.code,{children:"T"}),">(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,n.jsx)(t.tbody,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/storage/src/sessionStorage.ts#L5",children:"sessionStorage.ts:5"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"removelocalstorageitem",children:"removeLocalStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"removeLocalStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/storage/src/localStorage.ts#L20",children:"localStorage.ts:20"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"removesessionstorageitem",children:"removeSessionStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"removeSessionStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/storage/src/sessionStorage.ts#L20",children:"sessionStorage.ts:20"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"setlocalstorageitem",children:"setLocalStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"setLocalStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),", ",(0,n.jsx)(t.code,{children:"value"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"value"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"unknown"})})]})]})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/storage/src/localStorage.ts#L1",children:"localStorage.ts:1"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"setsessionstorageitem",children:"setSessionStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"setSessionStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),", ",(0,n.jsx)(t.code,{children:"value"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"value"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"unknown"})})]})]})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/storage/src/sessionStorage.ts#L1",children:"sessionStorage.ts:1"})})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},5392:(e,t,s)=>{s.d(t,{Z:()=>d,a:()=>i});var n=s(2784);const r={},l=n.createContext(r);function i(e){const t=n.useContext(l);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),n.createElement(l.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[49],{3695:(e,t,s)=>{s.r(t),s.d(t,{assets:()=>c,contentTitle:()=>i,default:()=>h,frontMatter:()=>l,metadata:()=>d,toc:()=>a});var n=s(2322),r=s(5392);const l={id:"modules",title:"@nf-team/storage - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},i=void 0,d={id:"storage/modules",title:"@nf-team/storage - v1.1.0",description:"Functions",source:"@site/docs/storage/modules.md",sourceDirName:"storage",slug:"/storage/modules",permalink:"/frontend-libraries/docs/storage/modules",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:.5,frontMatter:{id:"modules",title:"@nf-team/storage - v1.1.0",sidebar_label:"Exports",sidebar_position:.5,custom_edit_url:null},sidebar:"sidebar",previous:{title:"Readme",permalink:"/frontend-libraries/docs/storage/"},next:{title:"Readme",permalink:"/frontend-libraries/docs/fetch/"}},c={},a=[{value:"Functions",id:"functions",level:2},{value:"getLocalStorageItem",id:"getlocalstorageitem",level:3},{value:"Type parameters",id:"type-parameters",level:4},{value:"Parameters",id:"parameters",level:4},{value:"Returns",id:"returns",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"getSessionStorageItem",id:"getsessionstorageitem",level:3},{value:"Type parameters",id:"type-parameters-1",level:4},{value:"Parameters",id:"parameters-1",level:4},{value:"Returns",id:"returns-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"removeLocalStorageItem",id:"removelocalstorageitem",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"Returns",id:"returns-2",level:4},{value:"Defined in",id:"defined-in-2",level:4},{value:"removeSessionStorageItem",id:"removesessionstorageitem",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"Returns",id:"returns-3",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"setLocalStorageItem",id:"setlocalstorageitem",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"Returns",id:"returns-4",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"setSessionStorageItem",id:"setsessionstorageitem",level:3},{value:"Parameters",id:"parameters-5",level:4},{value:"Returns",id:"returns-5",level:4},{value:"Defined in",id:"defined-in-5",level:4}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,r.a)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(t.h2,{id:"functions",children:"Functions"}),"\n",(0,n.jsx)(t.h3,{id:"getlocalstorageitem",children:"getLocalStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"getLocalStorageItem"}),"<",(0,n.jsx)(t.code,{children:"T"}),">(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"type-parameters",children:"Type parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,n.jsx)(t.tbody,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/storage/src/localStorage.ts#L5",children:"localStorage.ts:5"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"getsessionstorageitem",children:"getSessionStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"getSessionStorageItem"}),"<",(0,n.jsx)(t.code,{children:"T"}),">(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"type-parameters-1",children:"Type parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"})})}),(0,n.jsx)(t.tbody,{children:(0,n.jsx)(t.tr,{children:(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"T"})})})})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(t.p,{children:[(0,n.jsx)(t.code,{children:"null"})," | ",(0,n.jsx)(t.code,{children:"T"})]}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/storage/src/sessionStorage.ts#L5",children:"sessionStorage.ts:5"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"removelocalstorageitem",children:"removeLocalStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"removeLocalStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/storage/src/localStorage.ts#L20",children:"localStorage.ts:20"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"removesessionstorageitem",children:"removeSessionStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"removeSessionStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsx)(t.tbody,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]})})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/storage/src/sessionStorage.ts#L20",children:"sessionStorage.ts:20"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"setlocalstorageitem",children:"setLocalStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"setLocalStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),", ",(0,n.jsx)(t.code,{children:"value"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"value"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"unknown"})})]})]})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/storage/src/localStorage.ts#L1",children:"localStorage.ts:1"})}),"\n",(0,n.jsx)(t.hr,{}),"\n",(0,n.jsx)(t.h3,{id:"setsessionstorageitem",children:"setSessionStorageItem"}),"\n",(0,n.jsxs)(t.p,{children:["\u25b8 ",(0,n.jsx)(t.strong,{children:"setSessionStorageItem"}),"(",(0,n.jsx)(t.code,{children:"key"}),", ",(0,n.jsx)(t.code,{children:"value"}),"): ",(0,n.jsx)(t.code,{children:"void"})]}),"\n",(0,n.jsx)(t.h4,{id:"parameters-5",children:"Parameters"}),"\n",(0,n.jsxs)(t.table,{children:[(0,n.jsx)(t.thead,{children:(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,n.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,n.jsxs)(t.tbody,{children:[(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"key"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"string"})})]}),(0,n.jsxs)(t.tr,{children:[(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"value"})}),(0,n.jsx)(t.td,{style:{textAlign:"left"},children:(0,n.jsx)(t.code,{children:"unknown"})})]})]})]}),"\n",(0,n.jsx)(t.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.code,{children:"void"})}),"\n",(0,n.jsx)(t.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,n.jsx)(t.p,{children:(0,n.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/storage/src/sessionStorage.ts#L1",children:"sessionStorage.ts:1"})})]})}function h(e={}){const{wrapper:t}={...(0,r.a)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},5392:(e,t,s)=>{s.d(t,{Z:()=>d,a:()=>i});var n=s(2784);const r={},l=n.createContext(r);function i(e){const t=n.useContext(l);return n.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),n.createElement(l.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/f423a5fc.99e85d74.js b/assets/js/f423a5fc.c1c2a314.js similarity index 87% rename from assets/js/f423a5fc.99e85d74.js rename to assets/js/f423a5fc.c1c2a314.js index a82df26a..8722817a 100644 --- a/assets/js/f423a5fc.99e85d74.js +++ b/assets/js/f423a5fc.c1c2a314.js @@ -1 +1 @@ -"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[996],{5403:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>c,default:()=>a,frontMatter:()=>r,metadata:()=>d,toc:()=>h});var i=n(2322),s=n(5392);const r={id:"FetchApiRequest",title:"Interface: FetchApiRequest",sidebar_label:"FetchApiRequest",sidebar_position:0,custom_edit_url:null},c=void 0,d={id:"fetch/interfaces/FetchApiRequest",title:"Interface: FetchApiRequest",description:"Type parameters",source:"@site/docs/fetch/interfaces/FetchApiRequest.md",sourceDirName:"fetch/interfaces",slug:"/fetch/interfaces/FetchApiRequest",permalink:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FetchApiRequest",title:"Interface: FetchApiRequest",sidebar_label:"FetchApiRequest",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"FetchError",permalink:"/frontend-libraries/docs/fetch/classes/FetchError"},next:{title:"@nf-team/stylelint-config",permalink:"/frontend-libraries/docs/stylelint-config/"}},l={},h=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"body",id:"body",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"config",id:"config",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"params",id:"params",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"timeout",id:"timeout",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"K"})}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"unknown"})})]})})]}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"body",children:"body"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"body"}),": ",(0,i.jsx)(t.code,{children:"unknown"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L18",children:"packages/fetch/src/fetch.ts:18"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"config"}),": ",(0,i.jsx)(t.code,{children:"Omit"}),"<",(0,i.jsx)(t.code,{children:"RequestInit"}),", ",(0,i.jsx)(t.code,{children:'"method"'})," | ",(0,i.jsx)(t.code,{children:'"body"'}),">"]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L20",children:"packages/fetch/src/fetch.ts:20"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"method",children:"method"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"method"}),": ",(0,i.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/modules#method",children:(0,i.jsx)(t.code,{children:"Method"})})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L17",children:"packages/fetch/src/fetch.ts:17"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"params",children:"params"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"params"}),": ",(0,i.jsx)(t.code,{children:"K"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L16",children:"packages/fetch/src/fetch.ts:16"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"timeout",children:"timeout"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"timeout"}),": ",(0,i.jsx)(t.code,{children:"number"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L19",children:"packages/fetch/src/fetch.ts:19"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"url",children:"url"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"url"}),": ",(0,i.jsx)(t.code,{children:"string"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/3b89c68/packages/fetch/src/fetch.ts#L15",children:"packages/fetch/src/fetch.ts:15"})})]})}function a(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},5392:(e,t,n)=>{n.d(t,{Z:()=>d,a:()=>c});var i=n(2784);const s={},r=i.createContext(s);function c(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function d(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:c(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([[996],{5403:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>d,default:()=>a,frontMatter:()=>r,metadata:()=>c,toc:()=>h});var i=n(2322),s=n(5392);const r={id:"FetchApiRequest",title:"Interface: FetchApiRequest",sidebar_label:"FetchApiRequest",sidebar_position:0,custom_edit_url:null},d=void 0,c={id:"fetch/interfaces/FetchApiRequest",title:"Interface: FetchApiRequest",description:"Type parameters",source:"@site/docs/fetch/interfaces/FetchApiRequest.md",sourceDirName:"fetch/interfaces",slug:"/fetch/interfaces/FetchApiRequest",permalink:"/frontend-libraries/docs/fetch/interfaces/FetchApiRequest",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",sidebarPosition:0,frontMatter:{id:"FetchApiRequest",title:"Interface: FetchApiRequest",sidebar_label:"FetchApiRequest",sidebar_position:0,custom_edit_url:null},sidebar:"sidebar",previous:{title:"FetchError",permalink:"/frontend-libraries/docs/fetch/classes/FetchError"},next:{title:"@nf-team/stylelint-config",permalink:"/frontend-libraries/docs/stylelint-config/"}},l={},h=[{value:"Type parameters",id:"type-parameters",level:2},{value:"Properties",id:"properties",level:2},{value:"body",id:"body",level:3},{value:"Defined in",id:"defined-in",level:4},{value:"config",id:"config",level:3},{value:"Defined in",id:"defined-in-1",level:4},{value:"method",id:"method",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"params",id:"params",level:3},{value:"Defined in",id:"defined-in-3",level:4},{value:"timeout",id:"timeout",level:3},{value:"Defined in",id:"defined-in-4",level:4},{value:"url",id:"url",level:3},{value:"Defined in",id:"defined-in-5",level:4}];function o(e){const t={a:"a",code:"code",h2:"h2",h3:"h3",h4:"h4",hr:"hr",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(t.h2,{id:"type-parameters",children:"Type parameters"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Name"}),(0,i.jsx)(t.th,{style:{textAlign:"left"},children:"Type"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"K"})}),(0,i.jsx)(t.td,{style:{textAlign:"left"},children:(0,i.jsx)(t.code,{children:"unknown"})})]})})]}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,i.jsx)(t.h3,{id:"body",children:"body"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"body"}),": ",(0,i.jsx)(t.code,{children:"unknown"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L18",children:"packages/fetch/src/fetch.ts:18"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"config",children:"config"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"config"}),": ",(0,i.jsx)(t.code,{children:"Omit"}),"<",(0,i.jsx)(t.code,{children:"RequestInit"}),", ",(0,i.jsx)(t.code,{children:'"method"'})," | ",(0,i.jsx)(t.code,{children:'"body"'}),">"]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L20",children:"packages/fetch/src/fetch.ts:20"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"method",children:"method"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"method"}),": ",(0,i.jsx)(t.a,{href:"/frontend-libraries/docs/fetch/modules#method",children:(0,i.jsx)(t.code,{children:"Method"})})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L17",children:"packages/fetch/src/fetch.ts:17"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"params",children:"params"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"params"}),": ",(0,i.jsx)(t.code,{children:"K"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L16",children:"packages/fetch/src/fetch.ts:16"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"timeout",children:"timeout"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.code,{children:"Optional"})," ",(0,i.jsx)(t.strong,{children:"timeout"}),": ",(0,i.jsx)(t.code,{children:"number"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L19",children:"packages/fetch/src/fetch.ts:19"})}),"\n",(0,i.jsx)(t.hr,{}),"\n",(0,i.jsx)(t.h3,{id:"url",children:"url"}),"\n",(0,i.jsxs)(t.p,{children:["\u2022 ",(0,i.jsx)(t.strong,{children:"url"}),": ",(0,i.jsx)(t.code,{children:"string"})]}),"\n",(0,i.jsx)(t.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.a,{href:"https://github.com/mbti-nf-team/frontend-libraries/blob/808e225/packages/fetch/src/fetch.ts#L15",children:"packages/fetch/src/fetch.ts:15"})})]})}function a(e={}){const{wrapper:t}={...(0,s.a)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(o,{...e})}):o(e)}},5392:(e,t,n)=>{n.d(t,{Z:()=>c,a:()=>d});var i=n(2784);const s={},r=i.createContext(s);function d(e){const t=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),i.createElement(r.Provider,{value:t},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.7275a8aa.js b/assets/js/runtime~main.5a69c375.js similarity index 91% rename from assets/js/runtime~main.7275a8aa.js rename to assets/js/runtime~main.5a69c375.js index 098f23de..5617ca6e 100644 --- a/assets/js/runtime~main.7275a8aa.js +++ b/assets/js/runtime~main.5a69c375.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,a,o,c={},n={};function d(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return c[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=c,d.c=n,e=[],d.O=(t,r,a,o)=>{if(!r){var c=1/0;for(b=0;b=o)&&Object.keys(d.O).every((e=>d.O[e](r[f])))?r.splice(f--,1):(n=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var c={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>c[t]=()=>e[t]));return c.default=()=>e,d.d(o,c),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({49:"a132c40c",109:"18c3d7cc",237:"1df93b7f",247:"479ba500",257:"68d9404b",368:"a94703ab",421:"111dc743",428:"50539457",453:"1005e1dd",518:"a7bd4aaa",627:"cb19188b",629:"aba21aa0",661:"5e95c892",724:"5192520c",767:"6acc1546",781:"49f38925",790:"b4570d6f",857:"35c8f0ed",862:"2ba16459",918:"17896441",971:"c377a04b",980:"a7456010",996:"f423a5fc"}[e]||e)+"."+{12:"815811d4",49:"01633b05",109:"ebdfee0e",237:"0124c7c2",247:"c5697708",257:"7e0f10a3",368:"0ee1141a",421:"f083efb2",428:"10177ba0",453:"54d7e93e",518:"d4067009",627:"2b9d880d",629:"07cbdb4f",661:"a749e18b",724:"b56765c5",767:"a0a3cc53",781:"88c798a5",790:"463ecd39",857:"ca3db5a7",862:"3e1b56cf",918:"7e9b6c06",971:"874169c4",980:"eb2ff304",996:"99e85d74"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="docs:",d.l=(e,t,r,c)=>{if(a[e])a[e].push(t);else{var n,f;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{n.onerror=n.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),f&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/frontend-libraries/",d.gca=function(e){return e={17896441:"918",50539457:"428",a132c40c:"49","18c3d7cc":"109","1df93b7f":"237","479ba500":"247","68d9404b":"257",a94703ab:"368","111dc743":"421","1005e1dd":"453",a7bd4aaa:"518",cb19188b:"627",aba21aa0:"629","5e95c892":"661","5192520c":"724","6acc1546":"767","49f38925":"781",b4570d6f:"790","35c8f0ed":"857","2ba16459":"862",c377a04b:"971",a7456010:"980",f423a5fc:"996"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var c=d.p+d.u(t),n=new Error;d.l(c,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),c=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+c+")",n.name="ChunkLoadError",n.type=o,n.request=c,a[1](n)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,c=r[0],n=r[1],f=r[2],i=0;if(c.some((t=>0!==e[t]))){for(a in n)d.o(n,a)&&(d.m[a]=n[a]);if(f)var b=f(d)}for(t&&t(r);i{"use strict";var e,t,r,a,o,c={},n={};function d(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return c[e].call(r.exports,r,r.exports,d),r.loaded=!0,r.exports}d.m=c,d.c=n,e=[],d.O=(t,r,a,o)=>{if(!r){var c=1/0;for(b=0;b=o)&&Object.keys(d.O).every((e=>d.O[e](r[f])))?r.splice(f--,1):(n=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},d.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return d.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,d.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);d.r(o);var c={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>c[t]=()=>e[t]));return c.default=()=>e,d.d(o,c),o},d.d=(e,t)=>{for(var r in t)d.o(t,r)&&!d.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},d.f={},d.e=e=>Promise.all(Object.keys(d.f).reduce(((t,r)=>(d.f[r](e,t),t)),[])),d.u=e=>"assets/js/"+({49:"a132c40c",109:"18c3d7cc",237:"1df93b7f",247:"479ba500",257:"68d9404b",368:"a94703ab",421:"111dc743",428:"50539457",453:"1005e1dd",518:"a7bd4aaa",627:"cb19188b",629:"aba21aa0",661:"5e95c892",724:"5192520c",767:"6acc1546",781:"49f38925",790:"b4570d6f",857:"35c8f0ed",862:"2ba16459",918:"17896441",971:"c377a04b",980:"a7456010",996:"f423a5fc"}[e]||e)+"."+{12:"815811d4",49:"0ac0cab3",109:"ebdfee0e",237:"0124c7c2",247:"78acc1c3",257:"1e63ad03",368:"0ee1141a",421:"f083efb2",428:"10177ba0",453:"a6f95f1e",518:"d4067009",627:"2b9d880d",629:"07cbdb4f",661:"a749e18b",724:"b56765c5",767:"fca4563d",781:"88c798a5",790:"463ecd39",857:"ca3db5a7",862:"04cd6a13",918:"7e9b6c06",971:"874169c4",980:"eb2ff304",996:"c1c2a314"}[e]+".js",d.miniCssF=e=>{},d.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),d.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="docs:",d.l=(e,t,r,c)=>{if(a[e])a[e].push(t);else{var n,f;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{n.onerror=n.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),f&&document.head.appendChild(n)}},d.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},d.p="/frontend-libraries/",d.gca=function(e){return e={17896441:"918",50539457:"428",a132c40c:"49","18c3d7cc":"109","1df93b7f":"237","479ba500":"247","68d9404b":"257",a94703ab:"368","111dc743":"421","1005e1dd":"453",a7bd4aaa:"518",cb19188b:"627",aba21aa0:"629","5e95c892":"661","5192520c":"724","6acc1546":"767","49f38925":"781",b4570d6f:"790","35c8f0ed":"857","2ba16459":"862",c377a04b:"971",a7456010:"980",f423a5fc:"996"}[e]||e,d.p+d.u(e)},(()=>{var e={303:0,532:0};d.f.j=(t,r)=>{var a=d.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var c=d.p+d.u(t),n=new Error;d.l(c,(r=>{if(d.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),c=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+c+")",n.name="ChunkLoadError",n.type=o,n.request=c,a[1](n)}}),"chunk-"+t,t)}},d.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,c=r[0],n=r[1],f=r[2],i=0;if(c.some((t=>0!==e[t]))){for(a in n)d.o(n,a)&&(d.m[a]=n[a]);if(f)var b=f(d)}for(t&&t(r);i Intro | @nf-team/frontend-libraries - + diff --git a/docs/core.html b/docs/core.html index d4ed57ef..f237b41e 100644 --- a/docs/core.html +++ b/docs/core.html @@ -4,7 +4,7 @@ @nf-team/core | @nf-team/frontend-libraries - + diff --git a/docs/core/modules.html b/docs/core/modules.html index b1347c1d..9c299c76 100644 --- a/docs/core/modules.html +++ b/docs/core/modules.html @@ -4,7 +4,7 @@ @nf-team/core - v2.1.0 | @nf-team/frontend-libraries - + @@ -18,7 +18,7 @@

ParametersReturns​

T[]

Defined in​

-

utils.ts:44

+

utils.ts:44

checkNumber​

▸ checkNumber(value?): number

@@ -27,7 +27,7 @@

ParametersReturns​

number

Defined in​

-

utils.ts:26

+

utils.ts:26

emptyAThenB​

▸ emptyAThenB(b, a?): string

@@ -36,7 +36,7 @@

ParametersReturns​

string

Defined in​

-

utils.ts:34

+

utils.ts:34

generateArrayOfNumber​

▸ generateArrayOfNumber(length): number[]

@@ -45,7 +45,7 @@

ParametersReturns​

number[]

Defined in​

-

utils.ts:64

+

utils.ts:64

isEmpty​

▸ isEmpty<T>(value?): boolean

@@ -56,7 +56,7 @@

ParametersReturns​

boolean

Defined in​

-

utils.ts:52

+

utils.ts:52

removeNullable​

▸ removeNullable(value?, replacementValue?): string

@@ -70,7 +70,7 @@

Returns
console.log(result); // 'newValue';

Defined in​

-

utils.ts:14

+

utils.ts:14

trueOrFalse​

▸ trueOrFalse(value?): boolean

@@ -79,6 +79,6 @@

ParametersReturns​

boolean

Defined in​

-

utils.ts:36

+

utils.ts:36

\ No newline at end of file diff --git a/docs/eslint-config.html b/docs/eslint-config.html index 3aea5436..701bf481 100644 --- a/docs/eslint-config.html +++ b/docs/eslint-config.html @@ -4,7 +4,7 @@ @nf-team/eslint-config | @nf-team/frontend-libraries - + diff --git a/docs/fetch.html b/docs/fetch.html index 918e9281..d69e73bc 100644 --- a/docs/fetch.html +++ b/docs/fetch.html @@ -4,7 +4,7 @@ @nf-team/fetch | @nf-team/frontend-libraries - + diff --git a/docs/fetch/classes/FetchError.html b/docs/fetch/classes/FetchError.html index 20009682..1dfe6295 100644 --- a/docs/fetch/classes/FetchError.html +++ b/docs/fetch/classes/FetchError.html @@ -4,7 +4,7 @@ Class: FetchError | @nf-team/frontend-libraries - + @@ -25,7 +25,7 @@

ReturnsOverrides​

Error.constructor

Defined in​

-

packages/fetch/src/fetch.ts:6

+

packages/fetch/src/fetch.ts:6

Properties​

message​

• message: string

@@ -51,7 +51,7 @@

Defined instatus​

• status: number

Defined in​

-

packages/fetch/src/fetch.ts:6

+

packages/fetch/src/fetch.ts:6

prepareStackTrace​

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

diff --git a/docs/fetch/interfaces/FetchApiRequest.html b/docs/fetch/interfaces/FetchApiRequest.html index f4d3ae33..c7bde528 100644 --- a/docs/fetch/interfaces/FetchApiRequest.html +++ b/docs/fetch/interfaces/FetchApiRequest.html @@ -4,7 +4,7 @@ Interface: FetchApiRequest<K> | @nf-team/frontend-libraries - + @@ -14,31 +14,31 @@

Propertiesbody​

• Optional body: unknown

Defined in​

-

packages/fetch/src/fetch.ts:18

+

packages/fetch/src/fetch.ts:18

config​

• Optional config: Omit<RequestInit, "method" | "body">

Defined in​

-

packages/fetch/src/fetch.ts:20

+

packages/fetch/src/fetch.ts:20

method​

• Optional method: Method

Defined in​

-

packages/fetch/src/fetch.ts:17

+

packages/fetch/src/fetch.ts:17

params​

• Optional params: K

Defined in​

-

packages/fetch/src/fetch.ts:16

+

packages/fetch/src/fetch.ts:16

timeout​

• Optional timeout: number

Defined in​

-

packages/fetch/src/fetch.ts:19

+

packages/fetch/src/fetch.ts:19

url​

• url: string

Defined in​

-

packages/fetch/src/fetch.ts:15

+

packages/fetch/src/fetch.ts:15

\ No newline at end of file diff --git a/docs/fetch/modules.html b/docs/fetch/modules.html index 03b81a5b..6ae3e9ba 100644 --- a/docs/fetch/modules.html +++ b/docs/fetch/modules.html @@ -4,7 +4,7 @@ @nf-team/fetch - v1.1.0 | @nf-team/frontend-libraries - + @@ -20,7 +20,7 @@

Type AliasesMethod​

Ƭ Method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"

Defined in​

-

packages/fetch/src/fetch.ts:12

+

packages/fetch/src/fetch.ts:12

Functions​

fetchApi​

▸ fetchApi<T, K>(«destructured»): Promise<T>

@@ -31,7 +31,7 @@

ParametersReturns​

Promise<T>

Defined in​

-

packages/fetch/src/fetch.ts:28

+

packages/fetch/src/fetch.ts:28

paramsSerializer​

▸ paramsSerializer<T>(params): string

@@ -42,6 +42,6 @@

ParametersReturns​

string

Defined in​

-

packages/fetch/src/fetch.ts:23

+

packages/fetch/src/fetch.ts:23

\ No newline at end of file diff --git a/docs/react.html b/docs/react.html index 05810237..c82d4551 100644 --- a/docs/react.html +++ b/docs/react.html @@ -4,7 +4,7 @@ @nf-team/react | @nf-team/frontend-libraries - + diff --git a/docs/react/modules.html b/docs/react/modules.html index 3af44e29..6e927644 100644 --- a/docs/react/modules.html +++ b/docs/react/modules.html @@ -4,7 +4,7 @@ @nf-team/react - v2.7.1 | @nf-team/frontend-libraries - + diff --git a/docs/react/modules/components.html b/docs/react/modules/components.html index 2a656639..e42b78c6 100644 --- a/docs/react/modules/components.html +++ b/docs/react/modules/components.html @@ -4,7 +4,7 @@ Module: components | @nf-team/frontend-libraries - + @@ -23,7 +23,7 @@

Returns
function ClintOnlyComponent() {
 return (
   <ClientOnly>
     <div>Render only client environment</div>
   </ClientOnly>
 );
}

Defined in​

-

packages/react/src/components/ClientOnly.tsx:22

+

packages/react/src/components/ClientOnly.tsx:22

DelayRenderComponent​

▸ DelayRenderComponent(«destructured»): null | Element

@@ -32,7 +32,7 @@

ParametersReturns​

null | Element

Defined in​

-

packages/react/src/components/DelayRenderComponent.tsx:12

+

packages/react/src/components/DelayRenderComponent.tsx:12

GlobalPortal​

▸ GlobalPortal(elementId): null | ReactPortal

@@ -49,6 +49,6 @@

Returns
html
<div id="portal-container" />
tsx
function SampleComponent() {

 return (
   <GlobalPortal elementId="portal-container">
     <div>Render component</div>
   </GlobalPortal>
 );
}

Defined in​

-

packages/react/src/components/GlobalPortal.tsx:34

+

packages/react/src/components/GlobalPortal.tsx:34

\ No newline at end of file diff --git a/docs/react/modules/hooks.html b/docs/react/modules/hooks.html index ee8a22eb..d2941b15 100644 --- a/docs/react/modules/hooks.html +++ b/docs/react/modules/hooks.html @@ -4,7 +4,7 @@ Module: hooks | @nf-team/frontend-libraries - + @@ -18,7 +18,7 @@

ParametersReturns​

ActionKeyEvent<T, U>

Defined in​

-

packages/react/src/hooks/useActionKeyEvent.ts:6

+

packages/react/src/hooks/useActionKeyEvent.ts:6

useBoolean​

▸ useBoolean(initialValue?): [boolean, () => void, () => void, (nextValue?: boolean) => void]

@@ -31,7 +31,7 @@

Returns
const [isOpen, openModal, closeModal, toggleModal] = useBoolean();

Defined in​

-

packages/react/src/hooks/useBoolean.ts:13

+

packages/react/src/hooks/useBoolean.ts:13

useDebounce​

▸ useDebounce<T>(value, delay?): T

@@ -42,7 +42,7 @@

ParametersReturns​

T

Defined in​

-

packages/react/src/hooks/useDebounce.ts:3

+

packages/react/src/hooks/useDebounce.ts:3

useEffectOnce​

▸ useEffectOnce(effect): void

@@ -51,21 +51,21 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useEffectOnce.ts:3

+

packages/react/src/hooks/useEffectOnce.ts:3

useGeolocation​

▸ useGeolocation(): [GeoLocation, () => void]

Returns​

[GeoLocation, () => void]

Defined in​

-

packages/react/src/hooks/useGeolocation.ts:15

+

packages/react/src/hooks/useGeolocation.ts:15

useIsFirstRender​

▸ useIsFirstRender(): boolean

Returns​

boolean

Defined in​

-

packages/react/src/hooks/useIsFirstRender.ts:3

+

packages/react/src/hooks/useIsFirstRender.ts:3

useIsMounted​

▸ useIsMounted(): boolean

@@ -77,7 +77,7 @@

Returns
const isMounted = useIsMounted();

useEffect(() => {
  if (isMounted) {
    return;
  }
}, [isMounted]);

Defined in​

-

packages/react/src/hooks/useIsMounted.ts:18

+

packages/react/src/hooks/useIsMounted.ts:18

useIsomorphicLayoutEffect​

▸ useIsomorphicLayoutEffect(effect, deps?): void

@@ -100,7 +100,7 @@

ParametersReturns​

boolean

Defined in​

-

packages/react/src/hooks/useLessThenScrollY.ts:5

+

packages/react/src/hooks/useLessThenScrollY.ts:5

useResizeViewportHeight​

▸ useResizeViewportHeight(): void

@@ -112,7 +112,7 @@

Returns
function SampleComponent() {
  useResizeViewportHeight();

  return <div>sample text</div>
}

Defined in​

-

packages/react/src/hooks/useResizeViewportHeight.ts:17

+

packages/react/src/hooks/useResizeViewportHeight.ts:17

useThrottleCallback​

▸ useThrottleCallback<U>(callback, dependencyList, delay): (...args: U) => void

@@ -128,7 +128,7 @@
ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useThrottleCallback.ts:3

+

packages/react/src/hooks/useThrottleCallback.ts:3

useTimeout​

▸ useTimeout(callback, delay): void

@@ -137,7 +137,7 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useTimeout.ts:5

+

packages/react/src/hooks/useTimeout.ts:5

useUnmount​

▸ useUnmount(fn): void

@@ -146,7 +146,7 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useUnmount.ts:5

+

packages/react/src/hooks/useUnmount.ts:5

useUpdateEffect​

▸ useUpdateEffect(effect, deps?): void

@@ -155,6 +155,6 @@

ParametersReturns​

void

Defined in​

-

packages/react/src/hooks/useUpdateEffect.ts:5

+

packages/react/src/hooks/useUpdateEffect.ts:5

\ No newline at end of file diff --git a/docs/storage.html b/docs/storage.html index 154272f2..696ff869 100644 --- a/docs/storage.html +++ b/docs/storage.html @@ -4,7 +4,7 @@ @nf-team/storage | @nf-team/frontend-libraries - + diff --git a/docs/storage/modules.html b/docs/storage/modules.html index 61c92689..6136b684 100644 --- a/docs/storage/modules.html +++ b/docs/storage/modules.html @@ -4,7 +4,7 @@ @nf-team/storage - v1.1.0 | @nf-team/frontend-libraries - + @@ -18,7 +18,7 @@

ParametersReturns​

null | T

Defined in​

-

localStorage.ts:5

+

localStorage.ts:5

getSessionStorageItem​

▸ getSessionStorageItem<T>(key): null | T

@@ -29,7 +29,7 @@

ParametersReturns​

null | T

Defined in​

-

sessionStorage.ts:5

+

sessionStorage.ts:5

removeLocalStorageItem​

▸ removeLocalStorageItem(key): void

@@ -38,7 +38,7 @@

ParametersReturns​

void

Defined in​

-

localStorage.ts:20

+

localStorage.ts:20

removeSessionStorageItem​

▸ removeSessionStorageItem(key): void

@@ -47,7 +47,7 @@

ParametersReturns​

void

Defined in​

-

sessionStorage.ts:20

+

sessionStorage.ts:20

setLocalStorageItem​

▸ setLocalStorageItem(key, value): void

@@ -56,7 +56,7 @@

ParametersReturns​

void

Defined in​

-

localStorage.ts:1

+

localStorage.ts:1

setSessionStorageItem​

▸ setSessionStorageItem(key, value): void

@@ -65,6 +65,6 @@

ParametersReturns​

void

Defined in​

-

sessionStorage.ts:1

+

sessionStorage.ts:1

\ No newline at end of file diff --git a/docs/stylelint-config.html b/docs/stylelint-config.html index e59b35ff..9b49cdfd 100644 --- a/docs/stylelint-config.html +++ b/docs/stylelint-config.html @@ -4,7 +4,7 @@ @nf-team/stylelint-config | @nf-team/frontend-libraries - + diff --git a/index.html b/index.html index f0302c58..1c4032b3 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ @nf-team/frontend-libraries | @nf-team/frontend-libraries - +