Skip to content

Commit e61702b

Browse files
vctrchuclaude
andcommitted
chore: tighten JSDoc comments for public package
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 459bdbd commit e61702b

2 files changed

Lines changed: 3 additions & 9 deletions

File tree

packages/ui-extensions/src/surfaces/point-of-sale/api/data-target-api/data-target-api.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ import {CartApi} from '../cart-api/cart-api';
22
import {StandardApi} from '../standard/standard-api';
33

44
/**
5-
* API surface for non-rendering data targets like `pos.app.ready.data`.
6-
* Provides the full POS extension API suite (StandardApi + CartApi) without
7-
* UI components. Data targets run in the background and process events
8-
* without rendering.
5+
* API surface for non-rendering data extension targets.
96
*/
107
export type DataTargetApi<T> = StandardApi<T> & CartApi;

packages/ui-extensions/src/surfaces/point-of-sale/extension-targets.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,8 @@ export interface EventExtensionTargets {
4848
export interface DataExtensionTargets {
4949
/**
5050
* A persistent background extension that starts when POS loads and runs for
51-
* the session's lifetime. Use this target for observing POS events like cart
52-
* updates and transaction completions without rendering UI.
53-
*
54-
* Register event listeners via `shopify.addEventListener()` and persist state
55-
* via `shopify.storage` for companion UI targets to read.
51+
* the session's lifetime. Use this target to observe POS events without
52+
* rendering UI.
5653
*/
5754
'pos.app.ready.data': RunnableExtension<
5855
DataTargetApi<'pos.app.ready.data'>,

0 commit comments

Comments
 (0)