Skip to content

Commit 7ff1a11

Browse files
committed
Update ICreateClientOpts.cryptoStore doc
1 parent 6752d18 commit 7ff1a11

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/client.ts

+6
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,11 @@ export interface ICreateClientOpts {
292292
* {@link setCryptoStoreFactory} if unspecified; or if no factory has been
293293
* specified, uses a default implementation (indexeddb in the browser,
294294
* in-memory otherwise).
295+
*
296+
* This is only used for the legacy crypto implementation (as used by {@link MatrixClient#initCrypto}),
297+
* but if you use the rust crypto implementation ({@link MatrixClient#initRustCrypto}) and the device
298+
* previously used legacy crypto (so must be migrated), then this must still be provided, so that the
299+
* data can be migrated from the legacy store.
295300
*/
296301
cryptoStore?: CryptoStore;
297302

@@ -1269,6 +1274,7 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
12691274
protected isGuestAccount = false;
12701275
protected ongoingScrollbacks: { [roomId: string]: { promise?: Promise<Room>; errorTs?: number } } = {};
12711276
protected notifTimelineSet: EventTimelineSet | null = null;
1277+
/* @deprecated */
12721278
protected cryptoStore?: CryptoStore;
12731279
protected verificationMethods?: string[];
12741280
protected fallbackICEServerAllowed = false;

0 commit comments

Comments
 (0)