LeaderWorkerInnerInitialMessage
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:59
Extends
Section titled “Extends”object&object&object&object&object&object&object&TaggedRequest<"InitialMessage",LeaderWorkerInnerInitialMessage,Encoded<object&object>,never,void,void,UnexpectedError, {_tag:"LiveStore.UnexpectedError";cause:unknown;note?:string;payload?:any; },never,this>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LeaderWorkerInnerInitialMessage(
props,options?):LeaderWorkerInnerInitialMessage
Defined in: node_modules/.pnpm/effect@3.18.0/node_modules/effect/dist/dts/Schema.d.ts:4265
Parameters
Section titled “Parameters”clientId
Section titled “clientId”string = Schema.String
debugInstanceId
Section titled “debugInstanceId”string = Schema.String
devtoolsEnabled
Section titled “devtoolsEnabled”boolean = Schema.Boolean
storageOptions
Section titled “storageOptions”{ directory?: string; type: "opfs"; } = StorageType
storageOptions.directory?
Section titled “storageOptions.directory?”string = ...
Default is livestore-${storeId}
When providing this option, make sure to include the storeId in the path to avoid
conflicts with other LiveStore apps.
storageOptions.type
Section titled “storageOptions.type”"opfs" = ...
storeId
Section titled “storeId”string = Schema.String
syncPayloadEncoded
Section titled “syncPayloadEncoded”undefined | JsonValue = ...
options?
Section titled “options?”MakeOptions
Returns
Section titled “Returns”LeaderWorkerInnerInitialMessage
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).constructor
Properties
Section titled “Properties”clientId
Section titled “clientId”
readonlyclientId:string=Schema.String
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:66
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).clientId
debugInstanceId
Section titled “debugInstanceId”
readonlydebugInstanceId:string=Schema.String
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:67
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).debugInstanceId
devtoolsEnabled
Section titled “devtoolsEnabled”
readonlydevtoolsEnabled:boolean=Schema.Boolean
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:64
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).devtoolsEnabled
storageOptions
Section titled “storageOptions”
readonlystorageOptions:object=StorageType
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:63
directory?
Section titled “directory?”
readonlyoptionaldirectory:string
Default is livestore-${storeId}
When providing this option, make sure to include the storeId in the path to avoid
conflicts with other LiveStore apps.
readonlytype:"opfs"
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).storageOptions
storeId
Section titled “storeId”
readonlystoreId:string=Schema.String
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:65
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).storeId
syncPayloadEncoded
Section titled “syncPayloadEncoded”
readonlysyncPayloadEncoded:undefined|JsonValue
Defined in: packages/@livestore/adapter-web/src/web-worker/common/worker-schema.ts:68
Inherited from
Section titled “Inherited from”Schema.TaggedRequest<LeaderWorkerInnerInitialMessage>()( 'InitialMessage', { payload: { storageOptions: StorageType, devtoolsEnabled: Schema.Boolean, storeId: Schema.String, clientId: Schema.String, debugInstanceId: Schema.String, syncPayloadEncoded: Schema.UndefinedOr(Schema.JsonValue), }, success: Schema.Void, failure: UnexpectedError, }, ).syncPayloadEncoded