-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
docs: fix Unstorage session driver examples #14409
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.
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
Open
MHJahanbakhsh
wants to merge
1
commit into
withastro:main
Choose a base branch
from
MHJahanbakhsh:fix/session-unstorage-docs-snippet-14339
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -159,33 +159,44 @@ Defines a function that removes session data by key. | |||||
|
|
||||||
| ## Unstorage compatibility | ||||||
|
|
||||||
| Unstorage driver types are compatible with Astro's `SessionDriver` type. | ||||||
| You can use an [unstorage](https://unstorage.unjs.io/) package export as a session driver [entrypoint](#entrypoint). For example: | ||||||
|
|
||||||
| That means you can use an unstorage package export as an [entrypoint](#entrypoint). For example: | ||||||
|
|
||||||
| ```ts title="driver/config.ts" {5} | ||||||
| ```ts title="driver/config.ts" {5-7} | ||||||
| import type { SessionDriverConfig } from 'astro' | ||||||
|
|
||||||
| export function configuredRedisDriver(): SessionDriverConfig { | ||||||
| return { | ||||||
| entrypoint: 'unstorage/drivers/redis', | ||||||
| config: { | ||||||
| tls: true | ||||||
| // Options are forwarded to the unstorage Redis driver (see its RedisOptions type) | ||||||
| ttl: 60 * 60 * 24 * 7, // 7 days | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| Alternatively, you can import and use an unstorage driver directly in the implementation. For example: | ||||||
| Alternatively, you can import an unstorage driver in the implementation and adapt it to Astro's `SessionDriver` interface. For example: | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The page doesn't explicitly says what is the
Suggested change
|
||||||
|
|
||||||
| ```ts title="driver/runtime.ts" {2} | ||||||
| ```ts title="driver/runtime.ts" | ||||||
| import type { SessionDriver } from 'astro' | ||||||
| import redisDriver from "unstorage/drivers/redis"; | ||||||
| import redisDriver, { type RedisOptions } from 'unstorage/drivers/redis' | ||||||
|
|
||||||
| export default function(config): SessionDriver { | ||||||
| return redisDriver({ | ||||||
| export default function (config: RedisOptions): SessionDriver { | ||||||
| const driver = redisDriver({ | ||||||
| ...config, | ||||||
| tls: true | ||||||
| ttl: config.ttl ?? 60 * 60 * 24 * 7, // default to 7 days | ||||||
| }) | ||||||
|
|
||||||
| return { | ||||||
| async getItem(key) { | ||||||
| return await driver.getItem(key) | ||||||
| }, | ||||||
| async setItem(key, value) { | ||||||
| await driver.setItem?.(key, value, {}) | ||||||
| }, | ||||||
| async removeItem(key) { | ||||||
| await driver.removeItem?.(key, {}) | ||||||
| }, | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Because we can't have a link here, I think the parentheses is not useful: