docs(pos): expose app background event methods#4569
Merged
Conversation
Assisted-By: devx/8cc1b236-8bf2-4f7a-b219-2778dd2786b4
vctrchu
force-pushed
the
vchu/pos-app-background-methods-docs
branch
from
85752d9 to
6c36f83
Compare
henryStelle
approved these changes
Jul 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a docs-only
Docs_AppBackgroundEventMethodsinterface that picksaddEventListenerandremoveEventListenerfromBackgroundShopifyGlobal, then regenerates the POS docs data.Why
These methods live on the
shopifyglobal for app background extensions. They aren't a named target API, so the docs need a named type to render the methods without changingDataTargetApior the target support mapping.Testing
yarn type-checkyarn lintgit diff --check