Skip to content

Commit

Permalink
chore(docs): remove internal properties from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
josselinonduty committed Sep 23, 2024
1 parent 2afdd9d commit a7d6d35
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/lib/uuid.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
*
* @see https://stackoverflow.com/a/2117523/12828306
* @license "CC BY-SA 4.0"
*
* @internal
*/

export function uuid() {
Expand Down
6 changes: 6 additions & 0 deletions src/server/Handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ export type EventHandlerFn = (
* @param prefix - The prefix to remove.
* @returns The path without the prefix.
*
* @internal
*
* @example
* subpath("/api/v1/users", "/not-api"); // "/api/v1/users"
* subpath("/api/v1/users", "/api/v1"); // "/users"
Expand All @@ -95,6 +97,8 @@ export function subpath(path: EventPath, prefix: EventPath): EventPath {
* @param suffix - The second path.
* @returns The joined path.
*
* @internal
*
* @example
* joinpath("/api", "/v1"); // "/api/v1"
* joinpath("/api/", "/v1"); // "/api/v1"
Expand All @@ -120,6 +124,8 @@ export function joinpath(path: EventPath, suffix: string): EventPath {
* @param request - The request object.
* @param router - The router object.
* @returns All layers that match the request.
*
* @internal
*/
export function getMatchingLayers(
request: WrakerRequest,
Expand Down

0 comments on commit a7d6d35

Please sign in to comment.