Generate reference docs

This commit is contained in:
dannykng committed 2022-09-14 14:25:44 -07:00
1 parent 274d046401
commit d784e62460
2 files changed
+51 -23

No files matched your search

@@ -11,13 +11,13 @@ import TabItem from '@theme/TabItem'
Generates email links and OTPs to be sent via a custom email provider.
```js
const { data, error } = await supabase.auth.admin.generateLink(
'email@example.com'
'signup',
{
'password': 'secret'
}
)
const { data, error } = await supabase.auth.admin.generateLink({
type: 'signup',
email: 'email@example.com',
options: {
password: 'secret',
},
})
```
## Parameters
@@ -133,23 +133,51 @@ No description provided.
## Examples
### Generate a signup link.
### Generate a signup link
```js
const { data, error } = await supabase.auth.admin.generateLink(
'email@example.com'
'signup',
{
'password': 'secret'
}
)
const { data, error } = await supabase.auth.admin.generateLink({
type: 'signup',
email: 'email@example.com',
options: {
password: 'secret',
},
})
```
### Generate an invite link.
### Generate an invite link
```js
const { data, error } = await supabase.auth.admin.generateLink(
'email@example.com'
'invite',
)
const { data, error } = await supabase.auth.admin.generateLink({
type: 'invite',
email: 'email@example.com',
})
```
### Generate a magic link
```js
const { data, error } = await supabase.auth.admin.generateLink({
type: 'magiclink',
email: 'email@example.com',
})
```
### Generate a recovery link
```js
const { data, error } = await supabase.auth.admin.generateLink({
type: 'recovery',
email: 'email@example.com',
})
```
### Generate a link to change email addresses
```js
const { data, error } = await supabase.auth.admin.generateLink({
type: 'email_change_current',
email: 'old.email@example.com',
newEmail: 'new.email@example.com',
})
```
+3 -3
View File
@@ -526,7 +526,7 @@ pages:
email: 'email@example.com'
})
```
- name: Generate an Magic link
- name: Generate a magic link
isSpotlight: false
js: |
```js
@@ -535,7 +535,7 @@ pages:
email: 'email@example.com'
})
```
- name: Generate an recovery link
- name: Generate a recovery link
isSpotlight: false
js: |
```js
@@ -544,7 +544,7 @@ pages:
email: 'email@example.com'
})
```
- name: Generate link to change email address
- name: Generate a link to change email addresses
isSpotlight: false
js: |
```js