@types/gapi.auth2

What is @types/gapi.auth2?

@types/gapi.auth2 provides TypeScript definitions for the Google API Client Library for JavaScript (gapi.auth2). This package allows developers to use TypeScript to interact with Google's OAuth 2.0 authentication system, enabling functionalities such as user sign-in, sign-out, and managing user sessions.

What are @types/gapi.auth2's main functionalities?

Initialize the Google Auth instance

This feature allows you to initialize the Google Auth instance with your client ID and the required scopes. This is the first step in setting up Google authentication in your application.

const auth2 = gapi.auth2.init({
  client_id: 'YOUR_CLIENT_ID.apps.googleusercontent.com',
  scope: 'profile email'
});

Sign in a user

This feature allows you to sign in a user using Google's OAuth 2.0. The code sample demonstrates how to sign in a user and log their basic profile information.

auth2.signIn().then(user => {
  console.log('User signed in:', user.getBasicProfile().getName());
});

Sign out a user

This feature allows you to sign out a user from your application. The code sample demonstrates how to sign out a user and log a confirmation message.

auth2.signOut().then(() => {
  console.log('User signed out');
});

Check if a user is signed in

This feature allows you to check if a user is currently signed in. The code sample demonstrates how to check the sign-in status and log it.

const isSignedIn = auth2.isSignedIn.get();
console.log('Is user signed in?', isSignedIn);

Other packages similar to @types/gapi.auth2

@types/gapi

@types/gapi provides TypeScript definitions for the Google API Client Library for JavaScript (gapi). While @types/gapi.auth2 focuses specifically on OAuth 2.0 authentication, @types/gapi covers a broader range of Google APIs, including but not limited to authentication.

react-google-login

react-google-login is a package that provides a React component for Google login. It simplifies the process of integrating Google sign-in into React applications. Unlike @types/gapi.auth2, which provides TypeScript definitions, react-google-login offers a higher-level abstraction specifically for React.

google-auth-library

google-auth-library is a Node.js client library for authenticating with Google APIs. It provides a comprehensive set of tools for managing OAuth 2.0 tokens and service accounts. While @types/gapi.auth2 is focused on client-side authentication, google-auth-library is designed for server-side use.

README

Installation

npm install --save @types/gapi.auth2

Summary

This package contains type definitions for non-npm package Google Sign-In API ( https://developers.google.com/identity/sign-in/web/ ).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gapi.auth2

Additional Details

• Last updated: Thu, 14 Feb 2019 16:51:53 GMT
• Dependencies: @types/gapi
• Global values: gapi

Credits

These definitions were written by Derek Lawless https://github.com/flawless2011.