Skip to content
Esc
navigateopen⌘Jpreview
Dashboard
On this page

supertokens-web-js/recipe/session/types

References documentation for the supertokens-web-js/recipe/session/types package

Type Aliases

InputType

type InputType = object & UserInput;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/types.ts

Type Declaration


RecipeEvent

type RecipeEvent = 
  | {
  action:   | "SIGN_OUT"
     | "REFRESH_SESSION"
     | "SESSION_CREATED"
     | "ACCESS_TOKEN_PAYLOAD_UPDATED"
     | "SESSION_ALREADY_EXISTS";
  userContext: any;
}
  | {
  action: "API_INVALID_CLAIM";
  claimValidationErrors: ClaimValidationError[];
  userContext: any;
}
  | {
  action: "UNAUTHORISED";
  sessionExpiredOrRevoked: boolean;
  userContext: any;
};

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/types.ts


RecipeInterface

type RecipeInterface = RecipeInterface;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/types.ts


UserInput

type UserInput = Omit<WebsiteInputType, 
  | "apiDomain"
  | "apiBasePath"
  | "enableDebugLogs"
  | "cookieHandler"
| "windowHandler">;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/types.ts

API reference

API schema and response details