Custom Storage

Why do I need storage?#

The storage is used to store the session (authentication keys, server salts and time offset)

It's easy. The custom storage must follow this API:

class CustomStorage {
  set(key: string, value: string): Promise<void>;
  get(key: string): Promise<string|null>;
}

Examples can be found in the last section

Create an instance of the custom storage and pass it to storageOptions.instance:

const instance = new CustomStorage();

new MTProto({
  storageOptions: {
    instance,
  },
});

The library includes ready-made storages:

const tempStorage = require('@mtproto/core/src/storage/temp');

new MTProto({
  storageOptions: {
    instance: tempStorage,
  },
});