docs: rename maxStringLength to largeStringThreshold

[liz709]

Updates docs to use the new preferred option name largeStringThreshold instead of maxStringLength. The old name is deprecated but still works (see dexie/Dexie.js#2290 for the code change).

Summary by CodeRabbit

• Documentation
  • Updated cloud configuration documentation to reflect the renaming of the string offloading parameter from maxStringLength to largeStringThreshold for improved clarity and consistency.

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation updates renaming a blob offloading configuration parameter from maxStringLength to largeStringThreshold across two cloud configuration guides, maintaining consistent parameter naming and behavior.

Changes

Cohort / File(s)	Summary
Blob Offloading Configuration Docs docs/cloud/blob-offloading.md, docs/cloud/sdk.md	Renamed the string offloading configuration option from maxStringLength to largeStringThreshold in both the general blob offloading guide and SDK client configuration documentation, keeping the default value (32768) and behavior intact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs: blob offloading, SDK, and REST API documentation #26: Updated the same blob-offloading and SDK documentation files, specifically renaming the client option for offloading large strings configuration.

Poem

🐰 A name more clear, a threshold renamed,
From maxStringLength to largeStringThreshold proclaimed,
Blobs offload with purpose, the docs now aligned,
Consistency across the guides, neatly designed! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The pull request title directly and clearly reflects the main change: renaming documentation references from maxStringLength to largeStringThreshold across multiple doc files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch liz/rename-maxStringLength-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (2)

docs/cloud/sdk.md (1)

50-50: Add a migration note for existing users of maxStringLength.

Given the deprecation context, consider adding a brief inline note that maxStringLength is still supported but deprecated, so upgrades are less ambiguous.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/cloud/sdk.md` at line 50, Add a short migration note beside the new
largeStringThreshold setting explaining that the old maxStringLength option is
still supported but deprecated; mention the equivalent behavior (e.g.,
largeStringThreshold replaces maxStringLength), advise users to switch to
largeStringThreshold and note it will be removed in a future release, and
reference the symbols maxStringLength and largeStringThreshold so readers can
find both in the docs.

docs/cloud/blob-offloading.md (1)

63-63: Consider tightening this paragraph for clarity.

Line 63 is dense and includes awkward wording (“exact same”, “a blob storage”). A shorter version would make this section easier to scan.

✍️ Suggested wording

-Strings longer than `largeStringThreshold` (default **32,768 characters**) are also offloaded to blob storage during sync. This is useful for properties that store base64-encoded images or other large text. Same principle goes here: You can store a 10 million chars string in Dexie but when it's time to sync, it will put the data in a blob storage and sync the reference to the blob location. Blob storage is protected with the exact same access control that was set for the data, as if it was stored inline, except for a grace period of 1 hour after access removal.
+Strings longer than `largeStringThreshold` (default **32,768 characters**) are also offloaded to blob storage during sync. This is useful for properties that store base64-encoded images or other large text. You can store a 10-million-character string in Dexie; during sync, Dexie Cloud uploads it to blob storage and syncs only a blob reference. Blob storage uses the same access control as inline data, with a 1-hour grace period after access removal.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/cloud/blob-offloading.md` at line 63, Rewrite the dense sentence to be
shorter and clearer: replace "Strings longer than `largeStringThreshold`..."
paragraph with a concise version that (1) states that strings over the threshold
(default 32,768) are offloaded to blob storage during sync, (2) gives a brief
concrete example (e.g., base64 images), and (3) clarifies access control by
saying blob data inherits the same access controls as inline data except for a
one-hour grace period after access removal; avoid phrases like "exact same" and
"a blob storage" for clearer wording.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/cloud/blob-offloading.md`:
- Line 63: Rewrite the dense sentence to be shorter and clearer: replace
"Strings longer than `largeStringThreshold`..." paragraph with a concise version
that (1) states that strings over the threshold (default 32,768) are offloaded
to blob storage during sync, (2) gives a brief concrete example (e.g., base64
images), and (3) clarifies access control by saying blob data inherits the same
access controls as inline data except for a one-hour grace period after access
removal; avoid phrases like "exact same" and "a blob storage" for clearer
wording.

In `@docs/cloud/sdk.md`:
- Line 50: Add a short migration note beside the new largeStringThreshold
setting explaining that the old maxStringLength option is still supported but
deprecated; mention the equivalent behavior (e.g., largeStringThreshold replaces
maxStringLength), advise users to switch to largeStringThreshold and note it
will be removed in a future release, and reference the symbols maxStringLength
and largeStringThreshold so readers can find both in the docs.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ed8a1994-3045-4e27-9cd4-dbd99a8af93f

📥 Commits

Reviewing files that changed from the base of the PR and between 01e74ac and cdd3860.

📒 Files selected for processing (2)

• docs/cloud/blob-offloading.md
• docs/cloud/sdk.md