fix(#142): update normalizeSync input type to string only

[harveysanders]

Description

Fix #142

Changes

• Make input parameter for normalizeSync, normalize required, string only
• Update README
• Update test

Testings

> [email protected] test
> vitest --coverage


 DEV  v0.25.7 /Users/opsparkowl/Documents/side_projects/normalize-diacritics
      Coverage enabled with c8

 ✓ src/tests/error.test.ts (2)
 ✓ src/tests/normalize-sync.test.ts (14)
 ✓ src/tests/normalize.test.ts (14)

 Test Files  3 passed (3)
      Tests  30 passed (30)
   Start at  15:51:55
   Duration  955ms (transform 406ms, setup 0ms, collect 175ms, tests 38ms)

 % Coverage report from c8
-------------------|---------|----------|---------|---------|-------------------
File               | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-------------------|---------|----------|---------|---------|-------------------
All files          |     100 |      100 |     100 |     100 |
 diacritics.ts     |     100 |      100 |     100 |     100 |
 index.ts          |     100 |      100 |     100 |     100 |
 normalize-sync.ts |     100 |      100 |     100 |     100 |
 normalize.ts      |     100 |      100 |     100 |     100 |
 types.ts          |     100 |      100 |     100 |     100 |
-------------------|---------|----------|---------|---------|-------------------

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	0	32.4 MB	typescript-bot

🚮 Removed packages: npm/[email protected]

View full report↗︎

[harveysanders]

@motss Thanks for the review. I've made the requested changes

[motss]

👍 LGTM!

@harveysanders Thanks for your contribution.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5f96d66) to head (dcd2469).
Report is 13 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #143   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          152       151    -1     
  Branches         5         5           
=========================================
- Hits           152       151    -1     

Flag	Coverage Δ
unit_tests	100.00% <100.00%> (ø)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[harveysanders]

@motss do you have an estimate when these changes will go into another release?

Thanks 🙂

[motss]

@harveysanders Apologies to the delay. The fix has been released in v5.0.0.

[harveysanders]

@motss No problem. Thanks!