Skip to content

Commit

Permalink
docs(http): improve unstable API notices (#5483)
Browse files Browse the repository at this point in the history
  • Loading branch information
iuioiua authored Jul 19, 2024
1 parent 2759686 commit 0cf0431
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions http/signed_cookie.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ function splitByLast(value: string, separator: string): [string, string] {
}

/**
* **UNSTABLE**: New API, yet to be vetted.
*
* Returns a promise with the signed cookie value from the given cryptographic
* key.
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* @experimental
*
* @example Usage
Expand Down Expand Up @@ -55,10 +56,11 @@ export async function signCookie(
}

/**
* **UNSTABLE**: New API, yet to be vetted.
*
* Returns a promise of a boolean indicating whether the signed cookie is valid.
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* @experimental
*
* @example Usage
Expand Down Expand Up @@ -98,10 +100,11 @@ export async function verifySignedCookie(
}

/**
* **UNSTABLE**: New API, yet to be vetted.
*
* Parses a signed cookie to get its value.
*
* > [!WARNING]
* > **UNSTABLE**: New API, yet to be vetted.
*
* Important: always verify the cookie using {@linkcode verifySignedCookie} first.
*
* @experimental
Expand Down

0 comments on commit 0cf0431

Please sign in to comment.