Skip to content

Commit 6c36f83

Browse files
committed
docs(pos): expose app background event methods
Assisted-By: devx/8cc1b236-8bf2-4f7a-b219-2778dd2786b4
1 parent 0feb6d8 commit 6c36f83

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

packages/ui-extensions/docs/surfaces/point-of-sale/generated/pos_ui_extensions/2026-07-rc/generated_docs_data_v2.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9257,5 +9257,30 @@
92579257
],
92589258
"value": "export interface BackgroundShopifyGlobal extends ShopifyGlobal {\n /**\n * Register a listener for a POS host event. Listeners are fire-and-forget:\n * their return values are ignored, and their errors are caught without\n * affecting the host or other listeners.\n */\n addEventListener<K extends keyof ShopifyEventMap>(\n type: K,\n listener: (event: ShopifyEventMap[K]) => void,\n ): void;\n\n /**\n * Remove a listener previously registered with `addEventListener`. The\n * `listener` reference must match the one used to register.\n */\n removeEventListener<K extends keyof ShopifyEventMap>(\n type: K,\n listener: (event: ShopifyEventMap[K]) => void,\n ): void;\n}"
92599259
}
9260+
},
9261+
"Docs_AppBackgroundEventMethods": {
9262+
"src/surfaces/point-of-sale/api/docs.ts": {
9263+
"filePath": "src/surfaces/point-of-sale/api/docs.ts",
9264+
"name": "Docs_AppBackgroundEventMethods",
9265+
"description": "Methods available on the `shopify` global for app background extensions.",
9266+
"isPublicDocs": true,
9267+
"members": [
9268+
{
9269+
"filePath": "src/surfaces/point-of-sale/api/docs.ts",
9270+
"syntaxKind": "MethodSignature",
9271+
"name": "addEventListener",
9272+
"value": "<K extends keyof ShopifyEventMap>(type: K, listener: (event: ShopifyEventMap[K]) => void) => void",
9273+
"description": "Register a listener for a POS host event. Listeners are fire-and-forget: their return values are ignored, and their errors are caught without affecting the host or other listeners."
9274+
},
9275+
{
9276+
"filePath": "src/surfaces/point-of-sale/api/docs.ts",
9277+
"syntaxKind": "MethodSignature",
9278+
"name": "removeEventListener",
9279+
"value": "<K extends keyof ShopifyEventMap>(type: K, listener: (event: ShopifyEventMap[K]) => void) => void",
9280+
"description": "Remove a listener previously registered with `addEventListener`. The `listener` reference must match the one used to register."
9281+
}
9282+
],
9283+
"value": "export interface Docs_AppBackgroundEventMethods\n extends Pick<\n BackgroundShopifyGlobal,\n 'addEventListener' | 'removeEventListener'\n > {}"
9284+
}
92609285
}
92619286
}
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import type {BackgroundShopifyGlobal} from '../globals';
2+
3+
/**
4+
* Methods available on the `shopify` global for app background extensions.
5+
* @publicDocs
6+
*/
7+
export interface Docs_AppBackgroundEventMethods
8+
extends Pick<
9+
BackgroundShopifyGlobal,
10+
'addEventListener' | 'removeEventListener'
11+
> {}

0 commit comments

Comments
 (0)