Storage Overview

Comfortable Sakai saves Assignments and Quizzes in the local storage of the browser.
Local storage of the browser can be used within the same browser extension and cannot be shared with other browser extensions.

For more information about the local storage, please visit https://developer.chrome.com/docs/extensions/reference/storage/.

Saving to Local Storage

• Primary Key: <Hostname>
• Secondary Key: <Key for value>
• Value: <Serialized Value>

tip

Primary key is required to distinguish between different Sakai LMS instances.

src/features/storage/index.ts

/**
 * Save data to Storage.
 * @param hostname - A PRIMARY key for storage. Usually a hostname of Sakai LMS.
 * @param key - A SECONDARY key for storage. Defined in `constant.ts`.
 * @param value - A data to be stored.
 */
export const toStorage = (hostname: string, key: string, value: any): Promise<string> => {
    const entity: { [key: string]: [value: any] } = {};
    entity[key] = value;
    return new Promise(function (resolve) {
        chrome.storage.local.get(hostname, function (items: any) {
            if (typeof items[hostname] === "undefined") {
                items[hostname] = {};
            }
            items[hostname][key] = value;
            chrome.storage.local.set({ [hostname]: items[hostname] }, () => {
                resolve("saved");
            });
        });
    });
};

Loading from Local Storage

• Primary Key: <Hostname>
• Secondary Key: <Key for value>
• Value: <Serialized Value>

tip

Primary key is required to distinguish between different Sakai LMS instances.

src/features/storage/index.ts

/**
 * Load data from Storage.
 * Type T is generics for return type.
 * @param hostname - A PRIMARY key for storage. Usually a hostname of Sakai LMS.
 * @param key - - A SECONDARY key for storage. Defined in `constant.ts`.
 * @param decoder - Decoder for generics type T.
 */
export const fromStorage = <T>(hostname: string, key: string, decoder: (data: any) => T): Promise<T> => {
    return new Promise(function (resolve) {
        chrome.storage.local.get(hostname, function (items: any) {
            if (hostname in items && key in items[hostname]) {
                resolve(decoder(items[hostname][key]));
            } else {
                resolve(decoder(undefined));
            }
        });
    });
};