Skip to content

Commit 61a6c27

Browse files
committed
chore: update docs for sameSite option
1 parent da9c954 commit 61a6c27

5 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/components/framework/cookie.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ let cookie = new Cookie('__session', {
1616
path: '/',
1717
httpOnly: true,
1818
secure: process.env.NODE_ENV === 'production',
19-
sameSite: 'strict',
19+
sameSite: 'Strict',
2020
maxAge: 60 * 60 * 24 * 30,
2121
});
2222
cookie.parse(request.headers.get('cookie'));
@@ -36,7 +36,7 @@ The following table describes the options for how the cookie is persisted within
3636
| maxAge | <code>number</code> | The [number of seconds until the cookie expires](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#max-agenumber). `maxAge` takes precedence over `expires` if both are defined. |
3737
| secure | <code>boolean</code> | Whether to secure the cookie so that the browser only sends the cookie over HTTPS. Some browsers [don't work with secure cookies on localhost](https://owasp.org/www-community/controls/SecureCookieAttribute). |
3838
| httpOnly | <code>boolean</code> | Whether to secure the cookie so that [client-side JavaScript can't read the cookie](https://owasp.org/www-community/HttpOnly). |
39-
| sameSite | <code>"lax" &#124; "strict" &#124; "none"</code> | Declares that the cookie should be restricted to a first-party or [same-site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) context. |
39+
| sameSite | <code>"Lax" &#124; "Strict" &#124; "None"</code> | Declares that the cookie should be restricted to a first-party or [same-site](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite) context. |
4040
| path | <code>string</code> | Tells the browser that the cookie should only be sent to the server if it's within the [defined path](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#path_attribute). |
4141
| domain | <code>string</code> | Secures the cookie so that it's only used on [specific domains](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#domain_attribute). |
4242

docs/components/framework/cookiesessionstorage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default defineConfig({
1919
path: '/',
2020
httpOnly: true,
2121
secure: process.env.NODE_ENV === 'production',
22-
sameSite: 'strict',
22+
sameSite: 'Strict',
2323
maxAge: 60 * 60 * 24 * 30,
2424
}),
2525
});

docs/components/framework/filesessionstorage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export default defineConfig({
2020
path: '/',
2121
httpOnly: true,
2222
secure: process.env.NODE_ENV === 'production',
23-
sameSite: 'strict',
23+
sameSite: 'Strict',
2424
maxAge: 60 * 60 * 24 * 30,
2525
}),
2626
});

docs/components/framework/memorysessionstorage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ export default defineConfig({
1919
path: '/',
2020
httpOnly: true,
2121
secure: process.env.NODE_ENV === 'production',
22-
sameSite: 'strict',
22+
sameSite: 'Strict',
2323
maxAge: 60 * 60 * 24 * 30,
2424
}),
2525
});

docs/framework/hydrogen-config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ export default defineConfig({
170170
/* Whether to secure the cookie so that the browser only sends the cookie over HTTPS. */
171171
secure: process.env.NODE_ENV === 'production',
172172
/* Declares that the cookie should be restricted to a first-party or same-site context. */
173-
sameSite: 'strict',
173+
sameSite: 'Strict',
174174
/* The number of seconds until the cookie expires. */
175175
maxAge: 60 * 60 * 24 * 30,
176176
}),

0 commit comments

Comments
 (0)