v0.0.5 - pojo

[wtasg]

v0.0.5 - Add pojo function

Changes:

• Added pojo<T extends object>(instance: T): Record<string, any> function that converts a class instance to a plain object by copying enumerable own properties only
• Exported pojo from main index files (src/index.ts, src/index.js, src/index.d.ts)
• Updated package version from 0.0.4 to 0.0.5
• Generated documentation for pojo function in docs/functions/pojo.md
• Updated docs.json and docs/globals.md to reflect the new export

Review effort: Low - straightforward utility function addition with documentation generation

[coderabbitai]

Walkthrough

A new pojo function is added to the library to convert class instances to plain objects. The function is exported through module entry points, comprehensive documentation is generated, and the package version is bumped from 0.0.4 to 0.0.5.

Changes

Cohort / File(s)	Summary
Module exports src/index.ts, src/index.js, src/index.d.ts	Added pojo to import and export statements alongside existing hello export across all entry points
Documentation metadata docs/docs.json	Updated hello declaration commit hash; added new pojo declaration with type parameters, parameters, and return type metadata
Documentation pages docs/functions/hello.md, docs/functions/pojo.md, docs/globals.md	Updated hello URL reference; added new pojo.md function documentation; extended globals reference list
Package metadata package.json	Version incremented from 0.0.4 to 0.0.5

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify export consistency across all three entry point files (src/index.ts, src/index.js, src/index.d.ts)
• Confirm documentation structure matches pojo function signature in docs/docs.json

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: version bump to 0.0.5 and addition of the new pojo function.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch v0.0.5

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 890fd5e and 01d2e57.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (8)

• docs/docs.json (4 hunks)
• docs/functions/hello.md (1 hunks)
• docs/functions/pojo.md (1 hunks)
• docs/globals.md (1 hunks)
• package.json (1 hunks)
• src/index.d.ts (1 hunks)
• src/index.js (1 hunks)
• src/index.ts (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/functions/pojo.md

1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🔇 Additional comments (9)

docs/functions/hello.md (1)

11-11: Documentation metadata update looks good.

The commit hash update reflects the new HEAD of the branch.

package.json (1)

3-3: Version bump is appropriate.

The 0.0.5 increment correctly reflects the addition of a new public function.

docs/globals.md (1)

10-10: Documentation index updated correctly.

The pojo function link follows the established pattern.

src/index.js (1)

2-3: Compiled output is consistent.

The JavaScript export matches the TypeScript source structure.

docs/functions/pojo.md (1)

9-35: Function documentation is clear and complete.

The documentation properly describes the function's behavior: converting class instances to plain objects by copying only own enumerable data properties.

src/index.d.ts (1)

2-3: Type definitions exported correctly.

The declaration file properly exposes the pojo function alongside hello.

docs/docs.json (2)

76-183: Documentation metadata is comprehensive.

The TypeDoc-generated metadata properly captures the pojo function's signature, type parameters, and documentation.

---

189-190: Functions group updated correctly.

The children array now includes both hello (1) and pojo (3) declarations.

src/index.ts (1)

2-7: Verification complete—pojo implementation and tests exist.

Implementation confirmed in src/pojo.ts with proper TypeScript typing and JSDoc documentation. Test files present: src/pojo.test.ts and src/pojo.test.js. Export structure in src/index.ts is correct.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}