Function CogsConnectionProvider
- CogsConnectionProvider<
Manifest extends CogsPluginManifest,
DataT extends { [key: string]: unknown } = { [key: string]: unknown },
>(
__namedParameters: {
audioPlayer?: boolean;
children: ReactNode;
hostname?: string;
initialClientState?: Partial<
DistributeObject<
{
[Name in string]: TypeFromCogsValueType<
Extract<DeepMutable<NonNullable<(...)>[number]>, { name: Name }>["value"],
>
},
>,
>;
initialDataStoreData?: DataT;
manifest: Manifest;
port?: number;
videoPlayer?: boolean;
},
): ReactNode
| null Type Parameters
- Manifest extends CogsPluginManifest
- DataT extends { [key: string]: unknown } = { [key: string]: unknown }
Parameters
- __namedParameters: {
audioPlayer?: boolean;
children: ReactNode;
hostname?: string;
initialClientState?: Partial<
DistributeObject<
{
[Name in string]: TypeFromCogsValueType<
Extract<DeepMutable<NonNullable<(...)>[number]>, { name: Name }>["value"],
>
},
>,
>;
initialDataStoreData?: DataT;
manifest: Manifest;
port?: number;
videoPlayer?: boolean;
}
Returns ReactNode | null
Create a persistent connection to COGS which can be accessed with
useCogsConnection()