Class AbstractSessionStoreAbstract

constructor

• new AbstractSessionStore(
      __namedParameters: SessionStoreOptions,
  ): AbstractSessionStore

  Parameters

  • __namedParameters: SessionStoreOptions

  Returns AbstractSessionStore

cookieConfig

secret

sessionCookieName

Optionalstore

isRolling

• get isRolling(): boolean

  isRolling returns true if rolling sessions are enabled.

  Returns boolean

calculateMaxAge

• calculateMaxAge(createdAt: number): number

  calculateMaxAge calculates the max age of the session based on createdAt and the rolling and absolute durations.

  Parameters

  • createdAt: number

  Returns number

Abstractdelete

• delete(
      reqCookies: RequestCookies | ReadonlyRequestCookies,
      resCookies: ResponseCookies,
  ): Promise<void>

  Parameters

  • reqCookies: RequestCookies | ReadonlyRequestCookies
  • resCookies: ResponseCookies

  Returns Promise<void>

deleteByReqCookies

• deleteByReqCookies(
      _reqCookies: RequestCookies | ReadonlyRequestCookies,
  ): Promise<void>

  Deletes the backing-store record for the session identified by the request cookies, without needing a response object. Used by IPSIE ceiling enforcement where only reqCookies are available (e.g. getSessionWithDomainCheck).

  For stateless cookie sessions this is a no-op — the cookie is the session, and clearing it requires response cookies. Ceiling enforcement returns null on every read anyway, so the orphaned cookie is harmless until its natural max-age expires.

  Subclasses that own a backing store (stateful) SHOULD override this to delete the store record by session ID for hygiene.

  Parameters

  • _reqCookies: RequestCookies | ReadonlyRequestCookies

  Returns Promise<void>

epoch

• epoch(): number

  epoch returns the time since unix epoch in seconds.

  Returns number

Abstractget

• get(
      reqCookies: RequestCookies | ReadonlyRequestCookies,
  ): Promise<SessionData | null>

  Parameters

  • reqCookies: RequestCookies | ReadonlyRequestCookies

  Returns Promise<SessionData | null>

Abstractset

• set(
      reqCookies: RequestCookies | ReadonlyRequestCookies,
      resCookies: ResponseCookies,
      session: SessionData,
      isNew?: boolean,
  ): Promise<void>

  save adds the encrypted session cookie as a Set-Cookie header. If the iat property is present on the session, then it will be used to compute the maxAge cookie value.

  Parameters

  • reqCookies: RequestCookies | ReadonlyRequestCookies
  • resCookies: ResponseCookies
  • session: SessionData
  • OptionalisNew: boolean

  Returns Promise<void>

shouldRollSession

• shouldRollSession(req: NextRequest): Promise<boolean>

  Parameters

  • req: NextRequest

  Returns Promise<boolean>