README.md

auth0-types

This package provides types for Auth0 Action Triggers.

It is not endorsed by, maintained by, or affiliated with Auth0 in any way.

Brought to you by Kpler - Intelligence tools for trade.

Installation

npm install -D @kpler/auth0-types

Available types

• credentials-exchange
  • CredentialsExchangeEvent
  • CredentialsExchangeApi
• post-challenge
  • PostChallengeEvent
  • PostChallengeApi
• post-change-password
  • PostChangePasswordEvent
  • PostChangePasswordApi
• post-login
  • PostLoginEvent
  • PostLoginApi
• post-user-registration
  • PostUserRegistrationEvent
  • PostUserRegistrationApi
• pre-user-registration
  • PreUserRegistrationEvent
  • PreUserRegistrationApi
• send-phone-message
  • SendPhoneMessageEvent
  • SendPhoneMessageApi

Usage (example)

import type { PostLoginApi, PostLoginEvent } from "@kpler/auth0-types";

export const onExecutePostLogin = async (
  event: PostLoginEvent,
  api: PostLoginApi,
) => {
  // "event" and "api" now have proper types!
};

Contributing

Contributions are welcome! Please adhere to the coding standards used and open a PR.

Use Conventional Commits for your commit messages and make sure your code passes the ESLint ruleset (npm run lint).

If you plan for larger changes, please create an issue first.

License

MIT