Skip to main content

requestReview

Triggers the host (Toss) app's App Store / Play Store review prompt. Whether the OS actually shows the dialog is up to the platform (iOS StoreKit / Android Play In-App Review) — the call does not guarantee that a prompt appears.

Signature​

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

declare function requestReview(): Promise<void>;

Parameters​

None.

Returns​

  • Promise<void> — resolves once the request is delivered. The return value gives no information about whether the dialog was actually shown.
No display guarantee

Both iOS and Android throttle review prompts internally to prevent spam. A prompt visible in development may never appear for real users. Ask at most once per meaningful milestone.

Permission​

No permission required.

Examples​

Minimal​

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

await requestReview();

Realistic — prompt after a meaningful milestone​

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

// Ask for a review when the user completes their 5th order.
async function onOrderComplete(orderCount: number) {
  if (orderCount === 5) {
    await requestReview();
  }
}

Try it live​

Open the Navigation page in sdk-example and run the requestReview card.

Open in sdk-example
  • closeView — close the current mini-app view.

External references​