Documents / @faasjs/react / FaasReactClient

Function: FaasReactClient()

FaasReactClient(options?): FaasReactClientInstance

Create and register a FaasReactClient instance.

The returned client is stored by baseUrl and becomes the default client used by helpers such as faas and useFaas. The instance-bound faas and useFaas helpers inject this baseUrl when request options do not provide one; the instance-bound FaasDataWrapper is always bound to this baseUrl.

Parameters

options?

FaasReactClientOptions = ...

Client configuration including base URL, default request options, and error hooks.

Returns

FaasReactClientInstance

Registered FaasReactClient instance.

Example

import { FaasReactClient, ResponseError } from '@faasjs/react'

declare module '@faasjs/types' {
  interface FaasActions {
    'features/users/api/get': {
      Params: { id: number }
      Data: { name: string }
    }
  }
}

type GetUserAction = 'features/users/api/get'

const client = FaasReactClient({
  baseUrl: 'http://localhost:8080/api/',
  onError: (action, params) => async (res) => {
    if (res instanceof ResponseError) {
      reportErrorToSentry(res, {
        tags: { action },
        extra: { params },
      })
    }
  },
})

const response = await client.faas<GetUserAction>('features/users/api/get', { id: 1 })