NhostProviderProps

Parameters

Documentation

Community

Blog

Reference

Guides

Dashboard

Support

Learn Nhost through guides and tutorials.

Getting Started

Database

GraphQL API

Realtime GraphQL API

Auth

Storage

Server-side code that works as API endpoints

Functions

Allocate CPU and Memory to your backend infrastructure

Compute Resources

Service Replicas

Grafana Instance configured and tailored to your project

Metrics

Environment Variables

Configure your Backend with Sensitive Data

Secrets

As simple as pushing your code to source control

Deployments

Custom Domains

Overview

Tools to develop and test Nhost projects locally

Nhost CLI

Available commands to run and manage local Nhost projects

Commands

React

Setup Nhost with React

Get up and running with Nhost and Next.js

Next.js

Setup Nhost with Next.js

Setup Nhost with Vue

In this quickstart guide, we'll demonstrate how to build a simple To-Do feature using Nhost and React Native.

React Native

Get up and running with Nhost and React Native

Build a Todo Manager with React

Build a Todo Manager with Next.js

Build a Todo Manager with Vue

Learn how to configure your Postgres server instance

Configuring Postgres

How to access the database directly using the connection string

Accessing the Database

List of available extensions with Nhost Postgres.

List of Available Extensions

Performance

Enabling Service

Local Development

Generate embeddings for your application automatically

Auto-Embeddings

Assistants

Empower your developers to code faster and better

Developer Assistant

Users

Follow this guide to sign in users with Apple.

Sign In with Apple

Follow this guide to sign in users with Discord.

Sign In with Discord

Follow this guide to sign in users with Facebook.

Sign In with Facebook

Follow this guide to sign in users with GitHub.

Sign In with GitHub

Follow this guide to sign in users with Google.

Sign In with Google

Follow this guide to sign in users with LinkedIn.

Sign In with LinkedIn

Follow this guide to sign in users with Spotify.

Sign In with Spotify

Follow this guide to sign in users with Twitch.

Sign In with Twitch

Follow this guide to sign in users with WorkOS.

Sign In with WorkOS

Add social sign in mechanism to existing users

Social Provider Connect

Email and Password

Sign In with Email and Password

Magic Links

Sign In with a Magic Link

SMS OTP

Sign In via SMS OTP

WebAuthn and Security Keys

Sign In with WebAuthn

Require extra permissions to perform critical operations

Elevated Permissions

Learn how to customize transactional emails

Email Templates

Custom JWTs

Learn how to configure your Hasura GraphQL Engine

Configuring Hasura

Permissions

Better visibility and security for your GraphQL API

Advanced Features

Antivirus

Supported execution runtimes and package managers

Runtimes and Dependencies

Configuration

Networking

Learn how to enable healthchecks for your services

Healthchecks

Resources

Learn how to use a private registry for your images

Registry

Developing with the Nhost stack and Run services locally

Local development

Configuration Overlays

Learn how to deploy your Run services using the CLI

CLI & CI Deployments

Learn how to start a development instance of Nhost

Learn how to migrate old projects to use the new configuration file

Migrate to Nhost Config

Learn how to run multiple Nhost projects locally

Running Multiple Projects

Learn about using seeds to populate your local database

Seeds

Configuring dnsmasq for network device connectivity to a local Nhost project

Connect Devices to Local Nhost Project

Sign Out

Upload File

Replace File

Delete File

Download File

Retrieve presigned URL to retrieve the file. Expiration of the URL is
determined by bucket configuration


Property	Type	Required
initial.user	`User`	✔️
initial.refreshToken	`null \| string`	✔️
initial.accessTokenExpiresIn	`number`	✔️
initial.accessToken	`string`	✔️
initial.refreshTokenId	`null \| string`

API Documentation

Backend Services

GraphQL

Client Libraries

NhostProviderProps

`NhostProviderProps`

Parameters

API Documentation

Backend Services

GraphQL

Client Libraries

​NhostProviderProps

​Parameters

`NhostProviderProps`

Parameters