search

vapor / websocket-kit

WebSocket client library built on SwiftNIO
https://docs.vapor.codes/4.0/advanced/websockets/
MIT License
272 stars 79 forks source link

Updates for API docs #128

Closed 0xTim closed 1 year ago

0xTim commented 1 year ago

Fixes imports and migrates API docs to DocC

codecov-commenter commented 1 year ago

Codecov Report

Merging #128 (71b7acb) into main (e0faccd) will decrease coverage by 4.61%. The diff coverage is 72.09%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #128 +/- ## ========================================== - Coverage 71.15% 66.55% -4.61% ========================================== Files 5 6 +1 Lines 475 601 +126 ========================================== + Hits 338 400 +62 - Misses 137 201 +64 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `66.55% <72.09%> (-4.61%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=vapor#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/vapor/websocket-kit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=vapor) | Coverage Δ | | |---|---|---| | [...bSocketKit/Concurrency/WebSocket+Concurrency.swift](https://codecov.io/gh/vapor/websocket-kit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=vapor#diff-U291cmNlcy9XZWJTb2NrZXRLaXQvQ29uY3VycmVuY3kvV2ViU29ja2V0K0NvbmN1cnJlbmN5LnN3aWZ0) | `29.78% <ø> (ø)` | | | [Sources/WebSocketKit/WebSocket+Connect.swift](https://codecov.io/gh/vapor/websocket-kit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=vapor#diff-U291cmNlcy9XZWJTb2NrZXRLaXQvV2ViU29ja2V0K0Nvbm5lY3Quc3dpZnQ=) | `97.50% <ø> (ø)` | | | [Sources/WebSocketKit/WebSocketClient.swift](https://codecov.io/gh/vapor/websocket-kit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=vapor#diff-U291cmNlcy9XZWJTb2NrZXRLaXQvV2ViU29ja2V0Q2xpZW50LnN3aWZ0) | `76.80% <66.66%> (+8.83%)` | :arrow_up: | | [Sources/WebSocketKit/WebSocket.swift](https://codecov.io/gh/vapor/websocket-kit/pull/128?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=vapor#diff-U291cmNlcy9XZWJTb2NrZXRLaXQvV2ViU29ja2V0LnN3aWZ0) | `72.11% <81.25%> (+0.32%)` | :arrow_up: |