Mobile Locker JavaScript SDK
    Preparing search index...

    Interface MobileLockerLocalForage

    localForage-compatible data API exposed by mobilelocker.localforage.

    Mirrors the localForage data API exactly, including Promises and optional callback variants. The Settings and Multiple Instances APIs are intentionally omitted — mobilelocker.localforage is a single pre-configured store.

    interface MobileLockerLocalForage {
        getItem<T>(
            key: string,
            callback?: (err: unknown, value: T | null) => void,
        ): Promise<T | null>;
        setItem<T>(
            key: string,
            value: T,
            callback?: (err: unknown, value: T) => void,
        ): Promise<T>;
        removeItem(key: string, callback?: (err: unknown) => void): Promise<void>;
        clear(callback?: (err: unknown) => void): Promise<void>;
        length(
            callback?: (err: unknown, numberOfKeys: number) => void,
        ): Promise<number>;
        key(
            keyIndex: number,
            callback?: (err: unknown, key: string) => void,
        ): Promise<string>;
        keys(callback?: (err: unknown, keys: string[]) => void): Promise<string[]>;
        iterate<T, U>(
            iteratee: (value: T, key: string, iterationNumber: number) => U,
            callback?: (err: unknown, result: U) => void,
        ): Promise<U>;
    }
    Index

    Methods

    getItem setItem removeItem clear length key keys iterate

    Methods

    • Type Parameters

      • T

      Parameters

      • key: string
      • Optionalcallback: (err: unknown, value: T | null) => void

      Returns Promise<T | null>

    • Type Parameters

      • T

      Parameters

      • key: string
      • value: T
      • Optionalcallback: (err: unknown, value: T) => void

      Returns Promise<T>

    • Parameters

      • key: string
      • Optionalcallback: (err: unknown) => void

      Returns Promise<void>

    • Parameters

      • Optionalcallback: (err: unknown) => void

      Returns Promise<void>

    • Parameters

      • Optionalcallback: (err: unknown, numberOfKeys: number) => void

      Returns Promise<number>

    • Parameters

      • keyIndex: number
      • Optionalcallback: (err: unknown, key: string) => void

      Returns Promise<string>

    • Parameters

      • Optionalcallback: (err: unknown, keys: string[]) => void

      Returns Promise<string[]>

    • Type Parameters

      • T
      • U

      Parameters

      • iteratee: (value: T, key: string, iterationNumber: number) => U
      • Optionalcallback: (err: unknown, result: U) => void

      Returns Promise<U>

    Settings

    Member Visibility

    On This Page

    Methods