chore(index): hide global from api docs

[Fdawgs]

Internal variable.

Checklist

• Run npm test
• Documentation has been updated and adheres to the style described in CONTRIBUTING.md
• Commit message adheres to the Conventional commits style, following the @commitlint/config-conventional config

[Copilot]

Pull Request Overview

This PR updates type definitions to accurately reflect actual usage and removes internal implementation details from public documentation. The changes align type annotations with the codebase's current implementation where all options are boolean-only.

• Restricted OptionDetails.type from union type 'boolean'|'number'|'string' to just 'boolean' to match actual usage
• Added @ignore tag to ERROR_MSGS constant and changed its type to Readonly<Record<string, string>> to hide it from public API documentation
• Updated API.md documentation to reflect the source code changes

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
src/index.js	Narrowed OptionDetails.type to 'boolean' only and marked ERROR_MSGS as internal with readonly type
API.md	Removed ERROR_MSGS documentation and updated OptionDetails.type documentation to reflect boolean-only type

Comments suppressed due to low confidence (1)

src/index.js:83

• This condition check for non-boolean types is now obsolete since OptionDetails.type has been narrowed to only 'boolean'. The logic can be simplified to just if (option) since all options are guaranteed to be boolean type.

				if (acceptedOption.type !== "boolean" || option) {

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.