Documents / @faasjs/react / FaasBrowserClient

Class: FaasBrowserClient

Browser client for FaasJS action requests from web applications.

Handles request URL construction, default and per-request option merging, before-request hooks, mock resolution for testing, and native fetch dispatching. When a global mock is configured with setMock, the mock response wins over both native fetch and a custom request option.

Example

import { FaasBrowserClient } from '@faasjs/react'

declare module '@faasjs/types' {
  interface FaasActions {
    'posts/get': {
      Params: { id: number }
      Data: { title: string }
    }
  }
}

type GetPostAction = 'posts/get'

const client = new FaasBrowserClient('https://api.example.com/', {
  headers: { 'X-Custom-Header': 'value' },
})

const response = await client.action<GetPostAction>('posts/get', { id: 1 })

console.log(response.data)

Constructors

Constructor

new FaasBrowserClient(baseUrl?, options?): FaasBrowserClient

Creates a new FaasBrowserClient instance.

Parameters

baseUrl?

`${string}/` = '/'

Base URL used to build action request URLs. Must end with /.

options?

Options = ...

Default request options merged into every request.

Returns

FaasBrowserClient

Throws

When baseUrl does not end with a forward slash.

Methods

action()

action<Path>(action, params?, options?): Promise<Response<FaasData<Path>>>

Makes a request to a FaasJS function.

Builds the request URL and resolved options, runs beforeRequest hooks, checks for mock handlers, and dispatches via native fetch or custom request. When stream is enabled the raw fetch response is returned so callers can consume the body stream themselves.

Type Parameters

Path

Path extends FaasActionPaths

Registered action path used to infer request params and response data.

Parameters

action

Path

Action path to invoke. Must be non-empty.

params?

FaasParams<Path>

Params sent to the action. Defaults to an empty object.

options?

Options

Per-request overrides on top of client defaults.

Returns

Promise<Response<FaasData<Path>>>

FaasJS response containing the parsed data, or native fetch response when streaming.

Throws

When action is empty or falsy.

Properties

baseUrl

baseUrl: `${string}/`

Base URL used to build action request URLs.

The action path is appended directly to this value, so it always ends with /.

defaultOptions

defaultOptions: Options

Default request options merged into every request.

id

readonly id: string

Unique identifier for this client instance.