Skip to content

docs: sync README API map with current exports#11

Merged
kelsos merged 1 commit intomainfrom
docs/api-map-sync
Apr 18, 2026
Merged

docs: sync README API map with current exports#11
kelsos merged 1 commit intomainfrom
docs/api-map-sync

Conversation

@kelsos
Copy link
Copy Markdown
Owner

@kelsos kelsos commented Apr 18, 2026

Summary

Pre-release hygiene: the API map table in `packages/plainfp/README.md` hadn't been updated since a few of the 0.1.0 additions landed. This PR aligns the Result and Option rows with what the barrels actually export.

Changes

  • Result row gains: `tap`, `tapError`, `toOption`
  • Option row gains: `tap`, `tapNone`, `all`, `any`, `zip`, `toResult`

All other namespaces (result-async, arrays, records, strings, predicates, functions, brand, non-empty-array, tagged, interop/zod) were already accurate — verified by cross-referencing each row against its `src//index.ts`.

Why now

Two-line fix before cutting 0.1.0 so the published npm page doesn't advertise an incomplete API surface. Integration tests PR to follow.

Test plan

  • All required CI checks pass (trivial change)

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.68%. Comparing base (003916b) to head (30549a3).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #11   +/-   ##
=======================================
  Coverage   91.68%   91.68%           
=======================================
  Files          23       23           
  Lines         397      397           
  Branches       90       90           
=======================================
  Hits          364      364           
  Misses         11       11           
  Partials       22       22           
Flag Coverage Δ
unittests 91.68% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 18, 2026

Merging this PR will not alter performance

✅ 48 untouched benchmarks


Comparing docs/api-map-sync (30549a3) with main (5153437)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (30549a3) during the generation of this report, so 5153437 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Update the API map table in packages/plainfp/README.md so the
Result and Option rows reflect what the barrels actually export.

Result now lists: tap, tapError, toOption (added in batch #1 and #2).
Option now lists: tap, tapNone, all, any, zip, toResult (same).

Verified every listed symbol against
packages/plainfp/src/<namespace>/index.ts; result-async / arrays /
records / strings / predicates / functions / brand / non-empty-array /
tagged / interop/zod rows were already correct.
@kelsos kelsos force-pushed the docs/api-map-sync branch from 2efec8a to 30549a3 Compare April 18, 2026 17:36
@kelsos kelsos merged commit 30549a3 into main Apr 18, 2026
10 checks passed
@kelsos kelsos deleted the docs/api-map-sync branch April 18, 2026 17:37
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