TBD54566975 / web5-js

Monorepo for the Web5 JS TypeScript implementation
https://tbd54566975.github.io/web5-js/
Apache License 2.0
118 stars 44 forks source link

Documented api package special case for changeset #710

Closed thehenrytsai closed 5 days ago

thehenrytsai commented 5 days ago
  1. Documented api package special case for changeset
  2. Other minor update to documentation around changeset
  3. Opportunistically updated pnpm-lock.yaml
changeset-bot[bot] commented 5 days ago

⚠️ No Changeset found

Latest commit: e5e700704b8a30f065718ad1e950871bbb310b03

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

github-actions[bot] commented 5 days ago

TBDocs Report

✅ No errors or warnings

@web5/api

@web5/crypto

@web5/crypto-aws-kms

@web5/dids

@web5/credentials


TBDocs Report Updated at 2024-06-25T20:34:38Z e5e7007

codecov[bot] commented 5 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.92%. Comparing base (987e6d5) to head (e5e7007).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #710 +/- ## ======================================= Coverage 90.91% 90.92% ======================================= Files 119 119 Lines 30167 30167 Branches 2250 2250 ======================================= + Hits 27426 27429 +3 + Misses 2706 2703 -3 Partials 35 35 ``` | [Components](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | Coverage Δ | | |---|---|---| | [agent](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `80.86% <ø> (ø)` | | | [api](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `94.15% <ø> (+0.14%)` | :arrow_up: | | [common](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `98.68% <ø> (ø)` | | | [credentials](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `94.88% <ø> (ø)` | | | [crypto](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `93.81% <ø> (ø)` | | | [dids](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `97.77% <ø> (ø)` | | | [identity-agent](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `96.70% <ø> (ø)` | | | [crypto-aws-kms](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `100.00% <ø> (ø)` | | | [proxy-agent](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `96.70% <ø> (ø)` | | | [user-agent](https://app.codecov.io/gh/TBD54566975/web5-js/pull/710/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=TBD54566975) | `96.70% <ø> (ø)` | |