Package Exports

@nhost/nhost-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@nhost/nhost-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Nhost JavaScript SDK

The Nhost JavaScript SDK provides a client-side interface to interact with Nhost services, including authentication, storage, and GraphQL operations.

Installation

# npm
npm install @nhost/nhost-js

# yarn
yarn add @nhost/nhost-js

# pnpm
pnpm add @nhost/nhost-js

Quick Start

import { createClient } from '@nhost/nhost-js'

// Initialize the Nhost client
const nhost = createClient({
  subdomain: 'your-project',
  region: 'eu-central-1'
})

// Use authentication features
const signinResponse = await nhost.auth.signInEmailPassword({
  email: 'user@example.com',
  password: 'password123'
})

if (signinResponse.body.session) {
  console.log('Signed in successfully!')
}

// Use GraphQL features
const graphqlResponse = await nhost.graphql.request({
  query: `
    query GetUsers {
      users {
        id
        displayName
        email
      }
    }
  `
})


// Use storage features
const storageResponse = await nhost.storage.uploadFiles({
  'file[]': [file]
})

return storageResponse.body.processedFiles[0]

// call a serverless function
const functionsResponse = await nhost.functions.fetch('/echo', {
  method: 'POST',
  body: JSON.stringify({
    message: 'Hello, world!'
  }),
  headers: {
    'Content-Type': 'application/json'
  }
})

Modules

The Nhost SDK consists of several modules:

Auth: User authentication and session management
Storage: File upload, download, and management
GraphQL: Executing queries and mutations against your Hasura GraphQL API
Functions: Invoking serverless functions

Documentation

For detailed documentation and API reference, see the Nhost Documentation.

License

MIT