Documents / @faasjs/react
@faasjs/react
React plugin for FaasJS.
Includes browser client utilities (FaasBrowserClient, ResponseError, setMock) and React helpers.
Features
- Support FaasJS Request Specifications.
- Support global and per-request configurations.
- Additional React functions:
- Utils:
equal: Compare two values for deep equality.createSplittingContext: Create a context for code splitting.useStates: Create splitting states.useStatesRef: Create splitting states with refs.
- Hooks:
useEqualMemoize: Memoize a value with deep equality.useEqualEffect: Run an effect with deep equality.useEqualMemo: Memoize a value with deep equality.useEqualCallback: Memoize a callback with deep equality.useConstant: Create a constant value with hooks.usePrevious: Get the previous value of a state.
- Components:
OptionalWrapper: Render a component optionally.ErrorBoundary: Catch errors in the component tree.
- Fetch Data:
faas: Fetch data from FaasJS.useFaas: Fetch data from FaasJS with hooks.useFaasStream: Fetch streaming data from FaasJS with hooks.FaasDataWrapper: Fetch data from FaasJS with a wrapper component.withFaasData: Fetch data from FaasJS using a higher-order component (HOC).
- Utils:
Install
npm install @faasjs/react react
Functions
- createSplittingContext
- equal
- faas
- FaasReactClient
- getClient
- OptionalWrapper
- setMock
- useConstant
- useEqualCallback
- useEqualEffect
- useEqualMemo
- useEqualMemoize
- useFaas
- useFaasStream
- usePrevious
- useStates
- useStatesRef
- withFaasData
Classes
Interfaces
Type Aliases
- BaseUrl
- ErrorChildrenProps
- FaasBrowserClientAction
- FaasDataInjection
- FaasDataWrapperProps
- FaasDataWrapperRef
- FaasReactClientInstance
- FaasReactClientOptions
- MockHandler
- OnError
- OptionalWrapperProps
- Options
- ResponseErrorProps
- ResponseHeaders
- ResponseProps
- StateRefs
- StateSetters
- StatesWithSetters
- StatesWithSettersAndRefs
- UseFaasOptions
- UseFaasStreamOptions
- UseFaasStreamResult