@grabjs/superapp-sdk
    Preparing search index...

    Class StorageModule

    SDK module for persisting key-value data to native storage via JSBridge.

    Stores data in the native app's persistent storage, allowing data to survive WebView restarts. All stored data is automatically removed when the user logs out. This code must run on the Grab SuperApp's WebView to function correctly.

    ES Module:

    import { StorageModule } from '@grabjs/superapp-sdk';
    const storage = new StorageModule();

    CDN (UMD):

    <script src="https://cdn.jsdelivr.net/npm/@grabjs/superapp-sdk@x.y.z/dist/index.js"></script>
    <script>
      const storage = new SuperAppSDK.StorageModule();
    </script>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    getBoolean getDouble getInt getString remove removeAll setBoolean setDouble setInt setString

    Constructors

    Methods

    • Retrieves a boolean value from the native storage.

      Parameters

      • key: string

        The key to retrieve the value for.

      Returns Promise<GetBooleanResponse>

      This method can return the following status_code values:

      • 200 (OK): Value retrieved successfully. The result contains GetBooleanResult.
      • 204 (No Content): Value not found in storage.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Get a boolean value
      const response = await storage.getBoolean('isDarkMode');

      // Handle the response
      if (isSuccess(response)) {
        if (response.status_code === 200) {
          console.log('Stored value:', response.result);
        } else if (response.status_code === 204) {
          console.log('No value stored for this key');
        }
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Retrieves a double (floating point) value from the native storage.

      Parameters

      • key: string

        The key to retrieve the value for.

      Returns Promise<GetDoubleResponse>

      This method can return the following status_code values:

      • 200 (OK): Value retrieved successfully. The result contains GetDoubleResult.
      • 204 (No Content): Value not found in storage.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Get a double value
      const response = await storage.getDouble('price');

      // Handle the response
      if (isSuccess(response)) {
        if (response.status_code === 200) {
          console.log('Stored value:', response.result);
        } else if (response.status_code === 204) {
          console.log('No value stored for this key');
        }
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Retrieves an integer value from the native storage.

      Parameters

      • key: string

        The key to retrieve the value for.

      Returns Promise<GetIntResponse>

      This method can return the following status_code values:

      • 200 (OK): Value retrieved successfully. The result contains GetIntResult.
      • 204 (No Content): Value not found in storage.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Get an integer value
      const response = await storage.getInt('userCount');

      // Handle the response
      if (isSuccess(response)) {
        if (response.status_code === 200) {
          console.log('Stored value:', response.result);
        } else if (response.status_code === 204) {
          console.log('No value stored for this key');
        }
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Retrieves a string value from the native storage.

      Parameters

      • key: string

        The key to retrieve the value for.

      Returns Promise<GetStringResponse>

      This method can return the following status_code values:

      • 200 (OK): Value retrieved successfully. The result contains GetStringResult.
      • 204 (No Content): Value not found in storage.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Get a string value
      const response = await storage.getString('username');

      // Handle the response
      if (isSuccess(response)) {
        if (response.status_code === 200) {
          console.log('Stored value:', response.result);
        } else if (response.status_code === 204) {
          console.log('No value stored for this key');
        }
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Removes a single value from the native storage by key.

      Parameters

      • key: string

        The key to remove from storage.

      Returns Promise<RemoveResponse>

      This method can return the following status_code values:

      • 204 (No Content): Value removed successfully.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Remove a value
      const response = await storage.remove('username');

      // Handle the response
      if (isSuccess(response)) {
        console.log('Value removed successfully');
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Removes all values from the native storage.

      Returns Promise<RemoveAllResponse>

      This method can return the following status_code values:

      • 204 (No Content): All values removed successfully.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Remove all values
      const response = await storage.removeAll();

      // Handle the response
      if (isSuccess(response)) {
        console.log('All values removed successfully');
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Stores a boolean value in the native storage.

      Parameters

      • key: string

        The key to store the value under.

      • value: boolean

        The boolean value to store.

      Returns Promise<SetBooleanResponse>

      This method can return the following status_code values:

      • 204 (No Content): Value stored successfully.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Set a boolean value
      const response = await storage.setBoolean('isDarkMode', true);

      // Handle the response
      if (isSuccess(response)) {
        console.log('Value stored successfully');
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Stores a double (floating point) value in the native storage.

      Parameters

      • key: string

        The key to store the value under.

      • value: number

        The double value to store.

      Returns Promise<SetDoubleResponse>

      This method can return the following status_code values:

      • 204 (No Content): Value stored successfully.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Set a double value
      const response = await storage.setDouble('price', 19.99);

      // Handle the response
      if (isSuccess(response)) {
        console.log('Value stored successfully');
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Stores an integer value in the native storage.

      Parameters

      • key: string

        The key to store the value under.

      • value: number

        The integer value to store.

      Returns Promise<SetIntResponse>

      This method can return the following status_code values:

      • 204 (No Content): Value stored successfully.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Set an integer value
      const response = await storage.setInt('userCount', 42);

      // Handle the response
      if (isSuccess(response)) {
        console.log('Value stored successfully');
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    • Stores a string value in the native storage.

      Parameters

      • key: string

        The key to store the value under.

      • value: string

        The string value to store.

      Returns Promise<SetStringResponse>

      This method can return the following status_code values:

      • 204 (No Content): Value stored successfully.
      • 400 (Bad Request): Invalid request parameters.
      • 424 (Failed Dependency): Storage operation failed.
      • 500 (Internal Server Error): Unexpected error occurred.
      • 501 (Not Implemented): Requires Grab app environment.

      mobile.storage

      import { StorageModule, isSuccess, isError } from '@grabjs/superapp-sdk';

      // Initialize the storage module
      const storage = new StorageModule();

      // Set a string value
      const response = await storage.setString('username', 'john_doe');

      // Handle the response
      if (isSuccess(response)) {
        console.log('Value stored successfully');
      } else if (isError(response)) {
        console.error(`Error ${response.status_code}: ${response.error}`);
      } else {
        console.error('Unhandled response');
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods