https://fluidframework.com/assets/js/61ec7e67.448f9ce0.js

1"use strict";(self.webpackChunkfluid_framework_website=self.webpackChunkfluid_framework_website||[]).push([[1601],{664215:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>d,metadata:()=>r,toc:()=>o});const r=JSON.parse('{"id":"api/test-utils/itestfluidobject-interface","title":"ITestFluidObject Interface","description":"To use, import via @fluidframework/test-utils/legacy.","source":"@site/versioned_docs/version-2/api/test-utils/itestfluidobject-interface.md","sourceDirName":"api/test-utils","slug":"/api/test-utils/itestfluidobject-interface","permalink":"/docs/v2/api/test-utils/itestfluidobject-interface","draft":false,"unlisted":false,"tags":[],"version":"2","frontMatter":{"title":"ITestFluidObject Interface","sidebar_label":"ITestFluidObject","displayed_sidebar":"docsSidebar"},"sidebar":"docsSidebar"}');var i=n(886070),s=n(403793);const d={title:"ITestFluidObject Interface",sidebar_label:"ITestFluidObject",displayed_sidebar:"docsSidebar"},a=void 0,l={},o=[{value:"Properties",id:"properties",level:2},{value:"Methods",id:"methods",level:2},{value:"Property Details",id:"property-details",level:2},{value:"Method Details",id:"method-details",level:2},{value:"Type Parameters",id:"type-parameters",level:5}];function c(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",h5:"h5",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,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(t.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:[(0,i.jsxs)(t.p,{children:["To use, import via ",(0,i.jsx)(t.code,{children:"@fluidframework/test-utils/legacy"}),"."]}),(0,i.jsxs)(t.p,{children:["For more information about our API support guarantees, see ",(0,i.jsx)(t.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})]}),"\n",(0,i.jsx)(t.h2,{id:"itestfluidobject-signature",children:"Signature"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"export interface ITestFluidObject extends IProvideTestFluidObject, IFluidLoadable\n"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Extends"}),": ",(0,i.jsx)(t.a,{href:"/docs/v2/api/test-utils/iprovidetestfluidobject-interface",children:"IProvideTestFluidObject"}),", ",(0,i.jsx)(t.a,{href:"/docs/v2/api/core-interfaces/ifluidloadable-interface",children:"IFluidLoadable"})]}),"\n",(0,i.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Property"}),(0,i.jsx)(t.th,{children:"Alerts"}),(0,i.jsx)(t.th,{children:"Modifiers"}),(0,i.jsx)(t.th,{children:"Type"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/test-utils/itestfluidobject-interface#channel-propertysignature",children:"channel"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"Beta"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"readonly"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/runtime-definitions/ifluiddatastorechannel-interface",children:"IFluidDataStoreChannel"})}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/test-utils/itestfluidobject-interface#context-propertysignature",children:"context"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"Beta"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"readonly"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/runtime-definitions/ifluiddatastorecontext-interface",children:"IFluidDataStoreContext"})}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/test-utils/itestfluidobject-interface#root-propertysignature",children:"root"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"Beta"})}),(0,i.jsx)(t.td,{}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/map/isharedmap-interface",children:"ISharedMap"})}),(0,i.jsx)(t.td,{})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/test-utils/itestfluidobject-interface#runtime-propertysignature",children:"runtime"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"Beta"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"readonly"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/datastore-definitions/ifluiddatastoreruntime-interface",children:"IFluidDataStoreRuntime"})}),(0,i.jsx)(t.td,{})]})]})]}),"\n",(0,i.jsx)(t.h2,{id:"methods",children:"Methods"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Method"}),(0,i.jsx)(t.th,{children:"Alerts"}),(0,i.jsx)(t.th,{children:"Return Type"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:(0,i.jsx)(t.a,{href:"/docs/v2/api/test-utils/itestfluidobject-interface#getsharedobject-methodsignature",children:"getSharedObject(id)"})}),(0,i.jsx)(t.td,{children:(0,i.jsx)(t.code,{children:"Beta"})}),(0,i.jsx)(t.td,{children:"Promise<T>"}),(0,i.jsx)(t.td,{})]})})]}),"\n",(0,i.jsx)(t.h2,{id:"property-details",children:"Property Details"}),"\n",(0,i.jsx)(t.h3,{id:"channel-propertysignature",children:"channel"}),"\n",(0,i.jsx)(t.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,i.jsxs)(t.p,{children:["For more information about our API support guarantees, see ",(0,i.jsx)(t.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"channel-signature",children:"Signature"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"readonly channel: IFluidDataStoreChannel;\n"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Type"}),": ",(0,i.jsx)(t.a,{href:"/docs/v2/api/runtime-definitions/ifluiddatastorechannel-interface",children:"IFluidDataStoreChannel"})]}),"\n",(0,i.jsx)(t.h3,{id:"context-propertysignature",children:"context"}),"\n",(0,i.jsx)(t.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,i.jsxs)(t.p,{children:["For more information about our API support guarantees, see ",(0,i.jsx)(t.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"context-signature",children:"Signature"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"readonly context: IFluidDataStoreContext;\n"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Type"}),": ",(0,i.jsx)(t.a,{href:"/docs/v2/api/runtime-definitions/ifluiddatastorecontext-interface",children:"IFluidDataStoreContext"})]}),"\n",(0,i.jsx)(t.h3,{id:"root-propertysignature",children:"root"}),"\n",(0,i.jsx)(t.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,i.jsxs)(t.p,{children:["For more information about our API support guarantees, see ",(0,i.jsx)(t.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"root-signature",children:"Signature"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"root: ISharedMap;\n"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Type"}),": ",(0,i.jsx)(t.a,{href:"/docs/v2/api/map/isharedmap-interface",children:"ISharedMap"})]}),"\n",(0,i.jsx)(t.h3,{id:"runtime-propertysignature",children:"runtime"}),"\n",(0,i.jsx)(t.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,i.jsxs)(t.p,{children:["For more information about our API support guarantees, see ",(0,i.jsx)(t.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"runtime-signature",children:"Signature"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"readonly runtime: IFluidDataStoreRuntime;\n"})}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Type"}),": ",(0,i.jsx)(t.a,{href:"/docs/v2/api/datastore-definitions/ifluiddatastoreruntime-interface",children:"IFluidDataStoreRuntime"})]}),"\n",(0,i.jsx)(t.h2,{id:"method-details",children:"Method Details"}),"\n",(0,i.jsx)(t.h3,{id:"getsharedobject-methodsignature",children:"getSharedObject"}),"\n",(0,i.jsx)(t.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,i.jsxs)(t.p,{children:["For more information about our API support guarantees, see ",(0,i.jsx)(t.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,i.jsx)(t.h4,{id:"getsharedobject-signature",children:"Signature"}),"\n",(0,i.jsx)(t.pre,{children:(0,i.jsx)(t.code,{className:"language-typescript",children:"getSharedObject<T = any>(id: string): Promise<T>;\n"})}),"\n",(0,i.jsx)(t.h5,{id:"type-parameters",children:"Type Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Parameter"}),(0,i.jsx)(t.th,{children:"Default"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"T"}),(0,i.jsx)(t.td,{children:"any"}),(0,i.jsx)(t.td,{})]})})]}),"\n",(0,i.jsx)(t.h4,{id:"getsharedobject-parameters",children:"Parameters"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Parameter"}),(0,i.jsx)(t.th,{children:"Type"}),(0,i.jsx)(t.th,{children:"Description"})]})}),(0,i.jsx)(t.tbody,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"id"}),(0,i.jsx)(t.td,{children:"string"}),(0,i.jsx)(t.td,{})]})})]}),"\n",(0,i.jsx)(t.h4,{id:"getsharedobject-returns",children:"Returns"}),"\n",(0,i.jsxs)(t.p,{children:[(0,i.jsx)(t.strong,{children:"Return type"}),": Promise<T>"]})]})}function h(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(c,{...e})}):c(e)}}

1,403793:(e,t,n)=>{n.d(t,{R:()=>d,x:()=>a});var r=n(830758);const i={},s=r.createContext(i);function d(e){const t=r.useContext(s);return r.useMemo((function(){return"function"==typeof e?e(t):{...t,...e}}),[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:d(e.components),r.createElement(s.Provider,{value:t},e.children)}}}]);