@skorpland/auth-js
Version:
Official client library for Powerbase Auth
51 lines (30 loc) • 1.72 kB
Markdown
# `auth-js`
An isomorphic JavaScript client library for the [Powerbase Auth](https://github.com/skorpland/auth) API.
## Docs
- Using `auth-js`: https://powerbase.club/docs/reference/javascript/auth-signup
- TypeDoc: https://skorpland.github.io/auth-js/v2
## Quick start
Install
```bash
npm install --save @skorpland/auth-js
```
Usage
```js
import { AuthClient } from '@skorpland/auth-js'
const GOTRUE_URL = 'http://localhost:9999'
const auth = new AuthClient({ url: GOTRUE_URL })
```
- `signUp()`: https://powerbase.club/docs/reference/javascript/auth-signup
- `signIn()`: https://powerbase.club/docs/reference/javascript/auth-signin
- `signOut()`: https://powerbase.club/docs/reference/javascript/auth-signout
### Custom `fetch` implementation
`auth-js` uses the [`cross-fetch`](https://www.npmjs.com/package/cross-fetch) library to make HTTP requests, but an alternative `fetch` implementation can be provided as an option. This is most useful in environments where `cross-fetch` is not compatible, for instance Cloudflare Workers:
```js
import { AuthClient } from '@skorpland/auth-js'
const AUTH_URL = 'http://localhost:9999'
const auth = new AuthClient({ url: AUTH_URL, fetch: fetch })
```
## Sponsors
We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves.
[](https://github.com/sponsors/skorpland)
