DEV-1545: fix Fliplet.Media.capture() return type doc (File web / Blob native)#287
Closed
farhantariq12b wants to merge 3 commits into
Closed
DEV-1545: fix Fliplet.Media.capture() return type doc (File web / Blob native)#287farhantariq12b wants to merge 3 commits into
farhantariq12b wants to merge 3 commits into
Conversation
…b native) Raised on fliplet-api PR #8369 (Arpanexe review): the doc promised capture() resolves with a File, but on native it can't — cordova-plugin-file overrides window.File, so the native implementation returns a Blob tagged with .name/.type/.lastModified instead. Clarify the return type per platform; both still work directly with Files.upload() and URL.createObjectURL(). Co-Authored-By: Claude <noreply@anthropic.com>
Deploying fliplet-cli with
|
| Latest commit: |
2e054e9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://792e9ea2.fliplet-cli.pages.dev |
| Branch Preview URL: | https://fix-dev-1545-file-blob-doc.fliplet-cli.pages.dev |
Ran the actual pipeline instead of hand-patching the derived files: cd docs && npm run test:unit && npm run check:docs && npm run check:v3-catalog - test:unit: 163/163 pass - check:docs --strict: 203 docs indexed, 46 V3 libraries, no catalog uniqueness violations - check:v3-catalog: 1 pre-existing error + 25 pre-existing warnings, none related to fliplet-media/capture() — unrelated drift already on master (e.g. "fliplet-service-worker" naming), out of scope here llms-full.txt also picked up an unrelated native-framework changelog update (Android 6.4.4 -> 6.4.7) that was already merged to master's source doc but never re-synced into this compiled bundle — a pre-existing staleness the regen fixes as a side effect. My hand-edit of the capture() paragraph in the prior commit was byte-identical to what the generator produces. Co-Authored-By: Claude <noreply@anthropic.com>
galisufyan-327
previously approved these changes
Jul 16, 2026
This reverts commit 956683d.
galisufyan-327
approved these changes
Jul 16, 2026
Contributor
Author
|
Closing alongside fliplet-api #8369 — DEV-1545 is back in To Do and being redesigned. This PR documented the Superseded, not rejected — the underlying finding (docs promised a |
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.
JIRA Issue
https://weboo.atlassian.net/browse/DEV-1545
Summary
Corrects the published
Fliplet.Media.capture()doc, which promised the resolved value is always aFile. On native,cordova-plugin-fileoverrideswindow.File, so the implementation (see fliplet-api PR #8369) resolves with aBlobtagged with.name/.type/.lastModifiedinstead of a realFilethere — a genuine nativeFilecan't be constructed. Web is unaffected; it already resolves with a realFile.Raised by the automated reviewer (Arpanexe) on fliplet-api PR #8369 as a doc/implementation contract mismatch.
Changes
docs/API/v3/media.md— capture() return type documented asFile(web) /Blob(native); both work directly withFiles.upload()andURL.createObjectURL().docs/.well-known/llms-full.txt— mirrored the same wording (compiled doc bundle).Scoped to just these two files — an earlier commit also regenerated the full doc build (which incidentally pulled in an unrelated pre-existing Android changelog sync + a catalog timestamp bump); reverted that so this PR only carries the capture() wording fix.
Verification
cd docs && npm run test:unit(163/163 pass) andnpm run check:docs --strict(203 docs, 46 V3 libraries, no catalog uniqueness violations) both green against this change.Risk Assessment
🤖 Generated with Claude Code