README.md

@fellow/auth-browser

The Auth Browser API provides the ability to open an in-app browser and subscribe to browser events.

On iOS, this uses ASWebAuthenticationSession and is compliant with leading OAuth service in-app-browser requirements.

on Android please use @capacitor/browser plugin.

Install

npm install @fellow/auth-browser
npx cap sync

Example

import { AuthBrowser } from '@fellow/auth-browser';

const LoginWithN = async (n: string) => {
    const result = await AuthBrowser.start({
		url: n,
		scheme: "myapp",
	});
    
	alert(JSON.stringify(result));
	if (result.success) {
		// Handle success, result.url should be defined
	} else {
        // Handle result.error
    }
};

API

• start(...)
• abort()
• Interfaces
• Type Aliases

start(...)

start(options: OpenOptions) => Promise<SuccessOrFailureResult>

iOS only: Open a page with the specified options.

Error on other platforms.

Param	Type
options	OpenOptions

Returns: Promise<SuccessOrFailureResult>

Since: 1.0.0

---

abort()

abort() => Promise<void>

iOS only: Close an open browser window.

Error on other platforms.

Since: 1.0.0

---

Interfaces

OpenOptions

Represents the options passed to open.

Prop	Type	Description	Since
url	string	The URL to which the browser is opened.	1.0.0
scheme	string	The Scheme that the browser should listen to for to redirect back to the app. For example if you want to use the scheme myapp:// you would pass myapp.

Type Aliases

SuccessOrFailureResult

SuccessResult | FailureResult

SuccessResult

{ success: true; url: string; }

FailureResult

{ success: false; error: string; }