GoTrueApi | /mod.ts | supabase@1.3.1

x/supabase/mod.ts>GoTrueApi#inviteUserByEmail

An isomorphic Javascript client for Supabase.

Popular

method GoTrueApi.prototype.inviteUserByEmail

Re-export

import { GoTrueApi } from "https://deno.land/x/supabase@1.3.1/mod.ts";

inviteUserByEmail(email: string, options?: { redirectTo?: string; data?: Record<string, unknown>; }): Promise<{ data: User | null; error: ApiError | null; }>

Sends an invite link to an email address.

Parameters

email: string

The email address of the user.

optional

options: { redirectTo?: string; data?: Record<string, unknown>; } = [UNSUPPORTED]

A URL or mobile address to send the user to after they are confirmed.

Returns

Promise<{ data: User | null; error: ApiError | null; }>