Skip to content

docs: correct preset, read, and serialization examples - #620

Open
Likio3000 wants to merge 1 commit into
typicode:mainfrom
Likio3000:docs/readme-api-examples-20260923
Open

Likio3000 wants to merge 1 commit into
typicode:mainfrom
Likio3000:docs/readme-api-examples-20260923

Conversation

@Likio3000

Copy link
Copy Markdown

The README currently calls a preset that is not exported, describes missing-file reads as replacing the database data with null, and shows DataFile callbacks that return undefined.

This corrects the preset import/name, documents preservation of default data when the file is absent, awaits the read example, and makes the custom serializer return its values while decrypting before JSON parsing.

Validation: checked against src/presets/node.ts, src/core/Low.ts, and the file adapters; verified the patch applies to the current README. No package installation or project scripts were run for this documentation-only change.

Prepared with AI assistance and checked against the source.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant