Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

§Classes

AuthApiError
AuthError
AuthImplicitGrantRedirectError
AuthInvalidCredentialsError
AuthInvalidTokenResponseError
AuthPKCEGrantCodeExchangeError
AuthRetryableFetchError
AuthSessionMissingError
AuthUnknownError
AuthWeakPasswordError

This error is thrown on certain methods when the password used is deemed weak. Inspect the reasons to identify what password strength rules are inadequate.

CustomAuthError
FunctionsError
FunctionsFetchError
FunctionsHttpError
FunctionsRelayError
GoTrueAdminApi
GoTrueClient
NavigatorLockAcquireTimeoutError
RealtimeChannel

A channel is the basic building block of Realtime and narrows the scope of data flow to subscribed clients. You can think of a channel as a chatroom where participants are able to see who's online and send and receive messages.

RealtimeClient
RealtimePresence
SupabaseClient

Supabase Client.

§Enums

FunctionRegion
REALTIME_LISTEN_TYPES
REALTIME_POSTGRES_CHANGES_LISTEN_EVENT
REALTIME_PRESENCE_LISTEN_EVENTS
REALTIME_SUBSCRIBE_STATES

§Variables

AuthAdminApi
AuthClient
createClient

Creates a new Supabase Client.

lockInternals
REALTIME_CHANNEL_STATES

§Functions

isAuthApiError
isAuthError
isAuthRetryableFetchError
isAuthWeakPasswordError
navigatorLock

Implements a global exclusive lock using the Navigator LockManager API. It is available on all browsers released after 2022-03-15 with Safari being the last one to release support. If the API is not available, this function will throw. Make sure you check availablility before configuring GoTrueClient.

§Interfaces

AdminUserAttributes
AMREntry

An authentication methord reference (AMR) entry.

AuthSession
AuthUser
Factor

A MFA factor.

GenerateLinkOptions
GoTrueAdminMFAApi

Contains the full multi-factor authentication administration API.

GoTrueMFAApi

Contains the full multi-factor authentication API.

Session
Subscription
UpdatableFactorAttributes
User
UserAppMetadata
UserAttributes
UserIdentity
UserMetadata
VerifyEmailOtpParams
VerifyMobileOtpParams
VerifyTokenHashParams

§Type Aliases

AuthChangeEvent
AuthChangeEventMFA
AuthenticatorAssuranceLevels
AuthFlowType
AuthMFAAdminDeleteFactorParams
AuthMFAAdminDeleteFactorResponse
AuthMFAAdminListFactorsParams
AuthMFAAdminListFactorsResponse
AuthMFAChallengeResponse
AuthMFAEnrollResponse
AuthMFAGetAuthenticatorAssuranceLevelResponse
AuthMFAListFactorsResponse
AuthMFAUnenrollResponse
AuthMFAVerifyResponse
AuthOtpResponse

AuthOtpResponse is returned when OTP is used.

AuthResponse
AuthResponsePassword
AuthTokenResponse
AuthTokenResponsePassword
CallRefreshTokenResult
EmailOtpType
FunctionInvokeOptions
GenerateEmailChangeLinkParams
GenerateInviteOrMagiclinkParams
GenerateLinkParams
GenerateLinkProperties

The properties related to the email link generated

GenerateLinkResponse
GenerateLinkType
GenerateRecoveryLinkParams
GenerateSignupLinkParams
GoTrueClientOptions
InitializeResult
LockFunc

Provide your own global lock implementation instead of the default implementation. The function should acquire a lock for the duration of the fn async function, such that no other client instances will be able to hold it at the same time.

MFAChallengeAndVerifyParams
MFAChallengeParams
MFAEnrollParams
MFAUnenrollParams
MFAVerifyParams
MobileOtpType
OAuthResponse
PageParams
Pagination
PostgrestError

Error format

PostgrestMaybeSingleResponse
PostgrestResponse
PostgrestSingleResponse
Provider

One of the providers supported by GoTrue.

QueryData
QueryError
QueryResult

Helper types for query results.

RealtimeChannelOptions
RealtimeChannelSendResponse
RealtimeClientOptions
RealtimeMessage
RealtimePostgresChangesFilter
RealtimePostgresChangesPayload
RealtimePostgresDeletePayload
RealtimePostgresInsertPayload
RealtimePostgresUpdatePayload
RealtimePresenceJoinPayload
RealtimePresenceLeavePayload
RealtimePresenceState
RealtimeRemoveChannelResponse
ResendParams
SignInAnonymouslyCredentials
SignInWithIdTokenCredentials
SignInWithOAuthCredentials
SignInWithPasswordCredentials
SignInWithPasswordlessCredentials
SignInWithSSO
SignOut
SignUpWithPasswordCredentials
SSOResponse
SupabaseClientOptions
SupportedStorage
UserResponse
VerifyOtpParams
WeakPassword
WeakPasswordReasons