createYCrdt function

Future<YCrdtWorld> createYCrdt({ required WasiConfig wasiConfig, required YCrdtWorldImports imports, Future<WasmModule> loadModule()?, WorkersConfig? workersConfig, })

Creates a YCrdtWorld with the given wasiConfig. It setsUp the dynamic library for wasm_run in native platforms and loads the y_crdt WASM module from the file system or from the url pointing to 'lib/y_crdt_wasm.wasm'.

If loadModule is provided, it will be used to load the WASM module. This can be useful if you want to provide a different configuration or implementation, or you are loading it from Flutter assets or from a different HTTP endpoint. By default, it will load the WASM module from the file system in lib/y_crdt_wasm.wasm either reading it directly in native platforms or with a GET request for Dart web.

Implementation

Future<YCrdtWorld> createYCrdt({
  required WasiConfig wasiConfig,
  required YCrdtWorldImports imports,
  Future<WasmModule> Function()? loadModule,
  WorkersConfig? workersConfig,
}) async {
  await WasmRunLibrary.setUp(override: false);

  final WasmModule module;
  if (loadModule != null) {
    module = await loadModule();
  } else {
    final uri = await WasmFileUris.uriForPackage(
      package: 'y_crdt',
      libPath: 'assets/y_crdt_wasm.wasm',
      envVariable: 'Y_CRDT_WASM_PATH',
    );
    final uris = WasmFileUris(uri: uri);
    module = await uris.loadModule();
  }
  final builder = module.builder(
    wasiConfig: wasiConfig,
    workersConfig: workersConfig,
  );

  return YCrdtWorld.init(builder, imports: imports);
}