1.0.1 • Published 3 years ago

expo-amplify-appauth v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Template for making easy-to-work-with tempates

expo-amplify-appauth

The Problem

AppAuth is awesome! It works great getting an authentication code for AWS Cognito! Then things break down. This package wraps AppAuth promptAsync pattern to automatically populate the Auth and Credentials objects from AWS Amplify front-end components to allow seamless communication with Cognito-authenticated AWS services.

This has been tested on user pools, but not identity pools.

expo-amplify-appauth - v1.0.1

expo-amplify-appauth - v1.0.1

Table of contents

References

Functions

References

default

Renames and exports: useAmplifyAppAuth

Functions

useAmplifyAppAuth

useAmplifyAppAuth(config): Object

Parameters

NameTypeDescription
configObjectOptions for initializing Amplify authentication using AppAuth in Expo
config.authorizationEndpoint?string-
config.clientIdstring-
config.clientSecret?string-
config.domain?string-
config.endPoint?string-
config.region?string-
config.scopes?string[]Oauth scopes (defaults to openid, which is fine for most use cases)
config.tokenEndpoint?string-
config.userPoolIdstring-

Returns

Object

NameType
currentUserundefined | CognitoUser
errorundefined | string
isLoggedInboolean
loadingboolean
promptAsync(...args: any[]) => Promise<AuthSessionResult>

Defined in

index.ts:38