Skip to content

Docs cleanup: align Buffer wording with Uint8Array-first v7 APIs #2321

@jasonandjay

Description

@jasonandjay

Summary

After the v7 migration, public APIs are Uint8Array-first, but some docs/JSDoc text still says "Buffer" in places where the canonical wording should now be "Uint8Array" (with optional note that Node Buffer is a Uint8Array subclass and remains accepted for compatibility).

Why

This can mislead users into thinking Buffer is still the primary API surface.

Scope (docs-only)

  • README wording cleanup where appropriate
  • JSDoc wording cleanup in source comments
  • Keep compatibility note where Buffer input remains accepted

Non-goals

  • No runtime behavior changes
  • No API signature changes

Acceptance

  • Docs consistently describe Uint8Array as canonical public type
  • Compatibility statement remains explicit for existing Buffer-accepting paths

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions