https://fluidframework.com/assets/js/9c020b28.9887af7c.js

1"use strict";(self.webpackChunkfluid_framework_website=self.webpackChunkfluid_framework_website||[]).push([[453],{136465:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>d,contentTitle:()=>a,default:()=>l,frontMatter:()=>o,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"api/container-definitions/iruntimefactory-interface","title":"IRuntimeFactory Interface","description":"Exported module definition","source":"@site/docs/api/container-definitions/iruntimefactory-interface.md","sourceDirName":"api/container-definitions","slug":"/api/container-definitions/iruntimefactory-interface","permalink":"/docs/api/container-definitions/iruntimefactory-interface","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"IRuntimeFactory Interface","sidebar_label":"IRuntimeFactory","displayed_sidebar":"docsSidebar"},"sidebar":"docsSidebar"}');var r=t(886070),s=t(403793);const o={title:"IRuntimeFactory Interface",sidebar_label:"IRuntimeFactory",displayed_sidebar:"docsSidebar"},a=void 0,d={},c=[{value:"Methods",id:"methods",level:2},{value:"Method Details",id:"method-details",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.p,{children:"Exported module definition"}),"\n",(0,r.jsx)(n.p,{children:"Provides the entry point for the ContainerContext to load the proper IRuntime to start up the running instance of the Container."}),"\n",(0,r.jsxs)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:[(0,r.jsxs)(n.p,{children:["To use, import via ",(0,r.jsx)(n.code,{children:"@fluidframework/container-definitions/legacy"}),"."]}),(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})]}),"\n",(0,r.jsx)(n.h2,{id:"iruntimefactory-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"export interface IRuntimeFactory extends IProvideRuntimeFactory\n"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Extends"}),": ",(0,r.jsx)(n.a,{href:"/docs/api/container-definitions/iprovideruntimefactory-interface",children:"IProvideRuntimeFactory"})]}),"\n",(0,r.jsx)(n.h2,{id:"methods",children:"Methods"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Method"}),(0,r.jsx)(n.th,{children:"Alerts"}),(0,r.jsx)(n.th,{children:"Return Type"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsx)(n.tbody,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.a,{href:"/docs/api/container-definitions/iruntimefactory-interface#instantiateruntime-methodsignature",children:"instantiateRuntime(context, existing)"})}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"Beta"})}),(0,r.jsxs)(n.td,{children:["Promise<",(0,r.jsx)(n.a,{href:"/docs/api/container-definitions/iruntime-interface",children:"IRuntime"}),">"]}),(0,r.jsx)(n.td,{children:"Instantiates a new IRuntime for the given IContainerContext to proxy to This is the main entry point to the Container's business logic"})]})})]}),"\n",(0,r.jsx)(n.h2,{id:"method-details",children:"Method Details"}),"\n",(0,r.jsx)(n.h3,{id:"instantiateruntime-methodsignature",children:"instantiateRuntime"}),"\n",(0,r.jsx)(n.p,{children:"Instantiates a new IRuntime for the given IContainerContext to proxy to This is the main entry point to the Container's business logic"}),"\n",(0,r.jsx)(n.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,r.jsxs)(n.p,{children:["For more information about our API support guarantees, see ",(0,r.jsx)(n.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,r.jsx)(n.h4,{id:"instantiateruntime-signature",children:"Signature"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-typescript",children:"instantiateRuntime(context: IContainerContext, existing: boolean): Promise<IRuntime>;\n"})}),"\n",(0,r.jsx)(n.h4,{id:"instantiateruntime-parameters",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Parameter"}),(0,r.jsx)(n.th,{children:"Type"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"context"}),(0,r.jsx)(n.td,{children:(0,r.jsx)(n.a,{href:"/docs/api/container-definitions/icontainercontext-interface",children:"IContainerContext"})}),(0,r.jsx)(n.td,{children:"container context to be supplied to the runtime"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:"existing"}),(0,r.jsx)(n.td,{children:"boolean"}),(0,r.jsx)(n.td,{children:"whether to instantiate for the first time or from an existing context"})]})]})]}),"\n",(0,r.jsx)(n.h4,{id:"instantiateruntime-returns",children:"Returns"}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Return type"}),": Promise<",(0,r.jsx)(n.a,{href:"/docs/api/container-definitions/iruntime-interface",children:"IRuntime"}),">"]})]})}function l(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},403793:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var i=t(830758);const r={},s=i.createContext(r);function o(e){const n=i.useContext(s);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),i.createElement(s.Provider,{value:n},e.children)}}}]);