This pull request includes several changes to improve the documentation, refactor the codebase, and add new features. The most important changes include adding a GitHub Actions workflow for building and deploying documentation, refactoring type imports, and enhancing the cache implementation with detailed comments and additional methods.
Documentation and Workflow Improvements:
Added a GitHub Actions workflow to build and deploy TypeDoc documentation (.github/workflows/docs.yaml).
Codebase Refactoring:
Moved type imports from server to types/server in various files (src/common/network/net.ts, src/common/router/DefaultRouter.ts, src/common/router/router.ts). [1][2][3]
Removed unnecessary ts property from Connection interface in net.ts and tcp.ts files (src/common/network/net.ts, src/common/network/tcp.ts). [1][2]
Feature Enhancements:
Added detailed comments and new methods to the DefaultCache class, including methods for clearing the cache and handling cache entries (src/plugins/cache/Cache.ts, src/plugins/cache/DefaultCache/index.ts). [1][2][3][4][5][6][7]
Dependency Management:
Corrected the misplaced dependency for @types/dns-packet in package.json (package.json). [1][2]
Code Export Adjustments:
Updated exports in src/index.ts to reorganize and simplify module exports (src/index.ts).
This pull request includes several changes to improve the documentation, refactor the codebase, and add new features. The most important changes include adding a GitHub Actions workflow for building and deploying documentation, refactoring type imports, and enhancing the cache implementation with detailed comments and additional methods.
Documentation and Workflow Improvements:
.github/workflows/docs.yaml
).Codebase Refactoring:
server
totypes/server
in various files (src/common/network/net.ts
,src/common/router/DefaultRouter.ts
,src/common/router/router.ts
). [1] [2] [3]ts
property fromConnection
interface innet.ts
andtcp.ts
files (src/common/network/net.ts
,src/common/network/tcp.ts
). [1] [2]Feature Enhancements:
DefaultCache
class, including methods for clearing the cache and handling cache entries (src/plugins/cache/Cache.ts
,src/plugins/cache/DefaultCache/index.ts
). [1] [2] [3] [4] [5] [6] [7]Dependency Management:
@types/dns-packet
inpackage.json
(package.json
). [1] [2]Code Export Adjustments:
src/index.ts
to reorganize and simplify module exports (src/index.ts
).