jam.ext.litestar.plugins

plugins ¶

Classes:

Name	Description
`JWTPlugin`	JWT Plugin for litestar.
`JamPlugin`	Simple Jam plugin for litestar.
`SessionsPlugin`	Server side sessions plugin for litestar.

JWTPlugin ¶

JWTPlugin(
    jam: BaseJam,
    cookie_name: Optional[str] = None,
    header_name: Optional[str] = "Authorization",
    user_dataclass: Any = User,
    auth_dataclass: Any = Auth,
)

Bases: InitPlugin

JWT Plugin for litestar.

Parameters:

Name	Type	Description	Default
`jam`	`BaseJam`	Jam instance	required
`cookie_name`	`str`	Cookie name for token check	`None`
`header_name`	`str`	Header name for token check	`'Authorization'`
`user_dataclass`	`Any`	Specific user dataclass	`User`
`auth_dataclass`	`Any`	Specific auth dataclass	`Auth`

Methods:

Name	Description
`on_app_init`	Init app config.

on_app_init ¶

on_app_init(app_config: AppConfig) -> AppConfig

Init app config.

JamPlugin ¶

JamPlugin(jam: BaseJam, dependency_key: str = 'jam')

Bases: InitPlugin

Simple Jam plugin for litestar.

The plugin adds Jam to Litestar DI.

Example

from litestar import Litestar from jam import Jam from jam.ext.litestar import JamPlugin jam = Jam() app = Litestar( plugins=[JamPlugin(jam=jam)], router_handlers=[your_router] )

Parameters:

Name	Type	Description	Default
`jam`	`BaseJam`	Jam instance	required
`dependency_key`	`str`	Key in Litestar DI	`'jam'`

Methods:

Name	Description
`on_app_init`	Litestar init.

on_app_init ¶

on_app_init(app_config: AppConfig) -> AppConfig

Litestar init.

SessionsPlugin ¶

SessionsPlugin(
    jam: BaseJam,
    cookie_name: Optional[str] = None,
    header_name: Optional[str] = "Authorization",
    user_dataclass: Any = User,
    auth_dataclass: Any = Auth,
)

Bases: InitPlugin

Server side sessions plugin for litestar.

Parameters:

Name	Type	Description	Default
`jam`	`BaseJam`	Jam instance	required
`cookie_name`	`str`	Cookie name for token check	`None`
`header_name`	`str`	Header name for token check	`'Authorization'`
`user_dataclass`	`Any`	Specific user dataclass	`User`
`auth_dataclass`	`Any`	Specific auth dataclass	`Auth`

Methods:

Name	Description
`on_app_init`	Init application.

on_app_init ¶

on_app_init(app_config: AppConfig) -> AppConfig

Init application.

FILE PATH: jam/ext/litestar/plugins.md