Nihilism Philisophy Major

    origin-storage
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    origin-storage

    Node CI npm version

    A same-origin storage for cross-domain access, it is based on localForage and supports IndexedDB, WebSQL and localStorage.

    origin-storage uses localStorage in browsers with no IndexedDB or WebSQL support. And Safari is not supported.

    Table of Contents

    Motivation

    When different Website domains need a same-origin storage container, we have to use iframe's same-origin policy Web local storage solution. localForage is an excellent storage library, it supports IndexedDB, WebSQL and localStorage, but it can't solve this problem directly.

    That's why we have this library for same-origin storage based on localForage.

    Installation

    yarn add origin-storage

    Usage and Example

    • Use OriginStorage on http://localhost:9000/storage.js:
    import { OriginStorage } from 'origin-storage';
    
    const originStorage = new OriginStorage();
    • Create and host a Web page(http://localhost:9000/storage.html) containing JavaScript file storage.js.

    • Use OriginStorageClient on a cross-domain page:

    import { OriginStorageClient } from 'origin-storage';
    
    const originStorageClient = new OriginStorageClient({
      uri: 'http://localhost:9000/storage.html',
    });

    API

    OriginStorage

    • new OriginStorage(options)
    interface OriginStorageOptions extends IFrameTransportInternalOptions {
      /**
       * @description
       *
       * Enable read access to OriginStorage.
       */
      read?: boolean;
      /**
       * @description
       *
       * Enable write access to OriginStorage.
       */
      write?: boolean;
      /**
       * @description
       *
       * Enable broadcast data changes on OriginStorage.
       */
      broadcastChanges?: boolean;
      /**
       * @description
       * 
       * Specify broadcastChannel name.
       */
      broadcastChannelName?: string;
    }

    OriginStorageClient

    • new OriginStorageClient(options)
    interface OriginStorageClientOptions extends IFrameMainTransportOptions {
      /**
       * @description
       *
       * Specify the uri of an OriginStorage container.
       */
      uri: string;
      /**
       * @description
       *
       * Set storage options for localforage.
       */
      storageOptions?: LocalForageOptions;
    }
    • OriginStorageClient instance methods.
    interface IOriginStorageClient {
      onConnect(callback: () => void): void;
      onChange(callback: (data: IChangeData) => void): void;
      getItem(key: string): Promise<any>;
      setItem(key: string, value: any): Promise<void>;
      removeItem(key: string): Promise<void>;
      clear(): Promise<void>;
      length(): Promise<number>;
      key(index: number): Promise<string>;
      keys(): Promise<string[]>;
    }

    Install

    npm i origin-storage

    DownloadsWeekly Downloads

    21

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    1.09 MB

    Total Files

    41

    Last publish

    Collaborators

    • unadlib