Rename peak() to peek() in IReaderBase with backward compatibility

[Copilot]

This PR addresses the misspelling of the peak() method in IReaderBase and its implementing classes by introducing the correctly spelled peek() method while maintaining full backward compatibility.

Changes Made

Interface Updates

• Added peek() method to IReaderBase interface with proper JSDoc documentation
• Marked existing peak() method as @deprecated with migration guidance

Implementation Updates

Updated all classes that implement the interface:

• Reader class
• StreamingReader class
• StreamingOctetReader class

Each implementation:

• Adds new peek() method with the actual implementation
• Converts peak() method to a deprecated wrapper that delegates to peek()
• Maintains identical behavior for both methods

Example Usage

import { Reader } from '@jsonjoy.com/util/lib/buffers/Reader';

const reader = new Reader();
reader.reset(new Uint8Array([72, 101, 108, 108, 111])); // "Hello"

// New recommended way
console.log(reader.peek()); // 72 (doesn't advance cursor)

// Old way (still works, but shows deprecation warning)
console.log(reader.peak()); // 72 (doesn't advance cursor)

Testing

• Added comprehensive test suite with 9 test cases
• Verifies both methods return identical values
• Tests all three implementing classes
• Confirms cursor position behavior is preserved
• All existing tests continue to pass

Backward Compatibility

• No breaking changes introduced
• Existing code using peak() continues to work unchanged
• IDEs will show deprecation warnings for peak() with migration guidance
• Type definitions support both method names

Fixes #6.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[streamich]

Move this description over to peek().

[Copilot]

Done. Moved the JSDoc description to the peek() method and kept only the deprecation notice on peak(). Commit: 59343e1

[streamich]

Remove whitespace inside a single unit test.

[Copilot]

Done. Removed the empty line in the test case. Commit: 59343e1

[streamich]

• When done, run yarn prettier to reformat the codebase.
• Use Angular style commits feat: <msg>.

[Copilot]

• When done, run yarn prettier to reformat the codebase.
• Use Angular style commits feat: <msg>.

Done. Formatted codebase with yarn prettier and applied Angular-style commit message format. Commit: f0fd4ff

[streamich]

LGTM

[github-actions]

🎉 This PR is included in version 1.7.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀