grab/superapp-sdk / skills
grabjs-superapp-sdk
VerifiedAPI reference for `@grabjs/superapp-sdk`. Use when building a MiniApp that runs in the Grab SuperApp WebView and needs to call native features (camera, payments, authorization, authentication, permission, location, device storage, container UI customization) via the Grab `JSBridge`. Keywords: miniapp, webview, android, ios, jsbridge, grab, superapp.
references/modules/StorageModule.md
View on GitHub# StorageModule
## API Reference
SDK module for persisting key-value data to native storage via `JSBridge`.
| Method | Returns | Description |
| :--- | :--- | :--- |
| `getBoolean(key: string)` | `Promise<GetBooleanResponse>` | Retrieves a boolean value from the native storage. |
| `getDouble(key: string)` | `Promise<GetDoubleResponse>` | Retrieves a double (floating point) value from the native storage. |
| `getInt(key: string)` | `Promise<GetIntResponse>` | Retrieves an integer value from the native storage. |
| `getString(key: string)` | `Promise<GetStringResponse>` | Retrieves a string value from the native storage. |
| `remove(key: string)` | `Promise<RemoveResponse>` | Removes a single value from the native storage by key. |
| `removeAll()` | `Promise<RemoveAllResponse>` | Removes all values from the native storage. |
| `setBoolean(key: string, value: boolean)` | `Promise<SetBooleanResponse>` | Stores a boolean value in the native storage. |
| `setDouble(key: string, value: number)` | `Promise<SetDoubleResponse>` | Stores a double (floating point) value in the native storage. |
| `setInt(key: string, value: number)` | `Promise<SetIntResponse>` | Stores an integer value in the native storage. |
| `setString(key: string, value: string)` | `Promise<SetStringResponse>` | Stores a string value in the native storage. |
## `getBoolean`
Retrieves a boolean value from the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `getBoolean(key: string): 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.
```typescript
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');
}
```
## `getDouble`
Retrieves a double (floating point) value from the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `getDouble(key: string): 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.
```typescript
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');
}
```
## `getInt`
Retrieves an integer value from the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `getInt(key: string): 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.
```typescript
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');
}
```
## `getString`
Retrieves a string value from the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `getString(key: string): 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.
```typescript
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');
}
```
## `remove`
Removes a single value from the native storage by key.
**OAuth Scope:** mobile.storage
**Signature:** `remove(key: string): 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.
```typescript
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');
}
```
## `removeAll`
Removes all values from the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `removeAll(): 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.
```typescript
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');
}
```
## `setBoolean`
Stores a boolean value in the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `setBoolean(key: string, value: boolean): 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.
```typescript
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');
}
```
## `setDouble`
Stores a double (floating point) value in the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `setDouble(key: string, value: number): 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.
```typescript
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');
}
```
## `setInt`
Stores an integer value in the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `setInt(key: string, value: number): 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.
```typescript
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');
}
```
## `setString`
Stores a string value in the native storage.
**OAuth Scope:** mobile.storage
**Signature:** `setString(key: string, value: string): 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.
```typescript
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');
}
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |