Storage.removeItem

지정한 키 하나를 비동기로 삭제합니다. 키가 존재하지 않아도 에러를 던지지 않고 정상적으로 resolve 됩니다(idempotent).

비공식 문서

이 페이지는 커뮤니티가 작성한 설명입니다. SDK의 동작은 상위의 @apps-in-toss/web-framework 배포본을 기준으로 합니다.

시그니처

import { Storage } from '@apps-in-toss/web-framework';

declare const Storage: {
  removeItem(key: string): Promise<void>;
  // ...overview 참고
};

파라미터

이름	타입	필수	설명
key	string	✓	삭제할 키. 정확히 일치하는 키 하나만 지웁니다 — prefix 매칭은 지원하지 않습니다. 여러 키를 한 번에 지우려면 clearItems를 쓰거나 키 목록을 직접 순회하세요.

반환값

• Promise<void> — 삭제가 완료되면 resolve. 키가 원래 없었던 경우에도 동일하게 resolve 됩니다.

권한

권한이 필요하지 않습니다 — Storage 네임스페이스는 별도의 PermissionName에 바인딩되지 않습니다. 권한이 필요한 다른 네임스페이스의 일반적인 처리 흐름은 Guides — 권한 처리 패턴을 참고하세요.

예제

최소 예제

import { Storage } from '@apps-in-toss/web-framework';

await Storage.removeItem('user.lastSeenScreen');

실전 예제 — 키 마이그레이션

import { Storage } from '@apps-in-toss/web-framework';

// v1: 'prefs', v2: 'user.prefs'로 키 네이밍을 옮긴 시나리오.
async function migratePrefs() {
  const legacy = await Storage.getItem('prefs');
  if (legacy === null) return; // 이미 마이그레이션됐거나 첫 사용자.

  const existing = await Storage.getItem('user.prefs');
  if (existing === null) {
    await Storage.setItem('user.prefs', legacy);
  }
  await Storage.removeItem('prefs');
}

직접 실행해 보기

sdk-example의 Storage 페이지에서 removeItem 카드를 실행해 결과를 확인할 수 있습니다.

→sdk-example에서 실행해 보기

관련 API

• Storage.getItem — 저장된 값을 읽습니다.
• Storage.setItem — 값을 저장합니다.
• Storage.clearItems — 미니앱이 저장한 모든 키를 삭제합니다.

관련 가이드

• Guides — 권한 처리 패턴 — 다른 네임스페이스의 권한 흐름 (참고용; Storage는 권한이 필요하지 않습니다).
• (작성 예정) Recipes — "사용자 설정 저장 패턴 (직렬화·마이그레이션·기본값)"

외부 참조

• @apps-in-toss/web-framework — 상위 SDK 패키지. 실제 export는 내부적으로 @apps-in-toss/web-bridge에서 가져옵니다.
• 표준 Web API 대응: Storage.removeItem (localStorage) — 동기 API라는 점이 다릅니다.