Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(http): improve unstable API notices #5483

Merged
merged 1 commit into from
Jul 19, 2024
Merged

docs(http): improve unstable API notices #5483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions http/signed_cookie.ts
View file
Open in desktop
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