@types/auth0-js

What is @types/auth0-js?

@types/auth0-js provides TypeScript definitions for the auth0-js library, which is used for implementing authentication and authorization in JavaScript applications using Auth0.

What are @types/auth0-js's main functionalities?

User Authentication

This feature allows you to initiate the authentication process by redirecting the user to the Auth0 login page.

const auth0 = new auth0.WebAuth({
  domain: 'YOUR_DOMAIN',
  clientID: 'YOUR_CLIENT_ID'
});

auth0.authorize({
  redirectUri: 'YOUR_CALLBACK_URL',
  responseType: 'token id_token',
  scope: 'openid profile email'
});

Handling Authentication Callback

This feature allows you to handle the authentication callback and retrieve the tokens from the URL hash.

auth0.parseHash((err, authResult) => {
  if (authResult && authResult.accessToken && authResult.idToken) {
    window.location.hash = '';
    // Save the tokens in local storage or state
  } else if (err) {
    console.error(err);
  }
});

User Logout

This feature allows you to log the user out and redirect them to a specified URL.

auth0.logout({
  returnTo: 'YOUR_RETURN_URL',
  clientID: 'YOUR_CLIENT_ID'
});

Silent Authentication

This feature allows you to silently authenticate the user without redirecting them to the Auth0 login page.

auth0.checkSession({}, (err, authResult) => {
  if (authResult && authResult.accessToken && authResult.idToken) {
    // User is authenticated
  } else if (err) {
    console.error(err);
  }
});

Other packages similar to @types/auth0-js

@auth0/auth0-spa-js

@auth0/auth0-spa-js is a JavaScript library for implementing authentication in single-page applications (SPAs) using Auth0. It provides a more modern and streamlined API compared to auth0-js, with built-in support for silent authentication and token renewal.

oidc-client

oidc-client is a JavaScript library for OpenID Connect (OIDC) and OAuth2 authentication. It provides similar functionalities to auth0-js but is more generic and can be used with any OIDC-compliant identity provider.

firebase

Firebase is a comprehensive platform for building web and mobile applications. It includes Firebase Authentication, which provides similar authentication functionalities to auth0-js but is tightly integrated with other Firebase services.

README

Installation

npm install --save @types/auth0-js

Summary

This package contains type definitions for auth0-js (https://github.com/auth0/auth0.js).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/auth0-js.

Additional Details

• Last updated: Wed, 29 May 2024 14:35:41 GMT
• Dependencies: none

Credits

These definitions were written by Adrian Chia, Matt Durrant, Peter Blazejewicz, Bartosz Kotrys, Mark Nelissen, Tyler Lindell, and Henri Kinnunen.