Browse Source

docs: Add note on session duration

Michael Bromley 2 years ago
parent
commit
7a42ca3d8d
1 changed files with 5 additions and 0 deletions
  1. 5 0
      docs/docs/guides/storefront/connect-api/index.mdx

+ 5 - 0
docs/docs/guides/storefront/connect-api/index.mdx

@@ -109,6 +109,11 @@ export async function request(query: string, variables: any) {
 
 
 There are some concrete examples of this approach in the examples later on in this guide.
 There are some concrete examples of this approach in the examples later on in this guide.
 
 
+### Session duration
+
+The duration of a session is determined by the [AuthOptions.sessionDuration](/reference/typescript-api/auth/auth-options#sessionduration) config
+property. Sessions will automatically extend (or "refresh") when a user interacts with the API, so in effect the `sessionDuration` signifies the
+length of time that a session will stay valid since the last API call.
 
 
 ## Specifying a channel
 ## Specifying a channel