Types Reference
Auto-generated from the source.
Every public TypeScript symbol exported from the four packages is captured in a TypeDoc snapshot at /typedoc.json. It's regenerated on every docs build from the actual source files, so the type declarations match the version of the library you'll install from npm.
How to use it
If you use VS Code or any TS-aware editor, you don't need this page — hover any imported symbol from @ackplus/nest-auth* and you'll see the same definitions.
If you want to browse without an editor:
- Pull the JSON:
curl <docs-site>/typedoc.json -o typedoc.json. - Drop into TypeDoc Explorer or any custom renderer.
Most-asked symbols
| Symbol | What it is |
|---|---|
IAuthModuleOptions | Top-level config for NestAuthModule.forRoot() |
IAuthModuleAsyncOptions | Async variant |
IUserHooks, IRegistrationHooks, ILoginHooks, IGuardHooks | Hook contracts |
ISignupRequest, ILoginRequest, IRefreshRequest | Request DTOs |
IAuthResponse, ITokenPair, ISessionUserData | Response DTOs |
INestAuthUser, INestAuthSession, INestAuthRole, etc. | Domain interfaces (mirror the entities) |
NestAuthMFAMethodEnum, NestAuthOTPTypeEnum, TenantModeEnum, SessionStorageType | Enums |
AuthClientConfig, RequestOptions | Client config |
StorageAdapter, HttpAdapter | Pluggable adapter contracts |
AuthContextValue | What useNestAuth() returns |
Source of truth
The type declarations live in packages/nest-auth-contracts/src/*.ts. If you want to read them directly without the TypeDoc round trip, the file naming is consistent: